Skip to main content
WEBHOOK

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Orb-Signature
string
required

v1= followed by the hex HMAC-SHA256 of v1:{X-Orb-Timestamp}:{raw request body}, keyed by the endpoint's webhook secret. The header may carry several space-separated signatures during a secret rotation; a receiver accepts the delivery when any v1 signature matches. Compare in constant time, and sign the bytes as received rather than a re-serialized body.

X-Orb-Timestamp
string<date-time>
required

When the delivery was signed, ISO 8601 to milliseconds. It is part of the signed message, so a receiver must reject timestamps outside its tolerance to stop replays.

Body

application/json

Issued when a customer accounting sync succeeds.

id
string
required

The ID of this webhook event.

created_at
string<date-time>
required

The time at which this event was created, to the second.

type
enum<string>
required

The event this payload describes.

Available options:
customer.accounting_sync_succeeded
customer
Customer · object
required

A customer is a buyer of your products, and the other party to the billing relationship.

In Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these match existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an external_customer_id with your own identifier. See Customer ID Aliases for further information about how these aliases work in Orb.

In addition to having an identifier in your system, a customer may exist in a payment provider solution like Stripe. Use the payment_provider_id and the payment_provider enum field to express this mapping.

A customer also has a timezone (from the standard IANA timezone database), which defaults to your account's timezone. See Timezone localization for information on what this timezone parameter influences within Orb.

accounting_sync_record
AccountingSyncRecordData · object
required
properties
AccountingSyncSucceededWebhookEventProperties · object
required

Response

2XX

Any 2xx acknowledges receipt.