Skip to main content

​
Create a webhook

POST /v2/webhooks

​
Request

Use this request to create a new webhook for a given webhookEventTypeName or webhookEventTypeId.

​
Request body schema

​
string (uuid)
When provided, we use this to generate a hash-based message authentication code (HMAC) using the SHA-256 algorithm. We Base64 encode this signature. Every event notification you receive for this webhook will include an x-em-signature header, if a shared secret has been provided. You can use this to verify the integrity and authenticity of the message.Allowable values: ≤ 36 characters
​
boolean
required
Whether or not the webhook should be enabled.Allowable values: true, false
​
string or null
The ID of the account. When provided, the webhook is scoped to the specified account and will only fire for events on that account. When omitted, the webhook is global and fires across all accounts in your multi-account configuration.Must be omitted for onboarding event types: AccountActivated, IdentityVerificationRequest, KycInformationRequested, KybInformationRequested, ApplicationStatusUpdated, AccountStatusUpdated. These are platform-level events that fire before an account exists.Allowable values: A valid accountId, or null
​
string
required
The name of the webhook event type that you want to create a webhook for.Allowable values: AccountCreated, AccountActivated, RecipientCreated, RecipientDeleted, BoxCredited, BoxDebited, OrderCreated, OrderFundsReceived, OrderCompleted, OrderCancelled, OrderModified, FeeCreated, FeeCompleted, 3DSAuthRequest, CardTransaction, DigitalWalletTokenTransition, PaymentBatchCreated, PaymentBatchProcessing, PaymentBatchValidationError, PaymentBatchCancelled, PaymentBatchCompleted, PaymentBatchOrderCreated, PaymentBatchOrderCompleted, PaymentBatchOrderCancelled, PaymentCreated, PaymentCompleted, PaymentReturned, RoqqettCheckoutSessionCompleted, RoqqettCheckoutSessionCancelled, RoqqettCheckoutSessionAbandoned
​
string (uuid)
required
The ID of the webhook event type that you want to create a webhook for.Allowable values: ≤ 36 characters
​
string
required
The URL of your webhook endpoint.Allowable values: ≤ 512 characters
​
string or null
The authorisation header content for the webhook.Allowable values: ≤ 512 characters
​
object or null
Narrows which events the webhook receives. Currently this applies only to Roqqett checkout session events (RoqqettCheckoutSessionCompleted, RoqqettCheckoutSessionCancelled and RoqqettCheckoutSessionAbandoned), and the only supported filter is checkoutId with the in operator. For example, { "checkoutId": { "in": ["6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"] } } delivers events for that checkout only. Any other key is rejected with a 400 response. An event without a checkoutId, such as any non-Roqqett event, is never delivered to a webhook with a checkoutId filter. Omit filters to receive events for every checkout.Allowable values: A filters object whose checkoutId.in holds 1 to 100 checkout IDs, or null

​
Response

For more detailed information about this request and its response, see the API reference.