Create a Webhook subscription

post https://api-sbx.sidedrawersbx.com/api/v1/developers/tenant/tenant-id/{tenantId}/webhooks

Creates a Webhook subscription for a given Tenant.

Path Params

tenantId

string

required

Unique Tenant identifier.

Query Params

connectionType

string

Defaults to HTTP

Communication protocol: HTTP or SOCKET. Default: HTTP.

Body Params

modificationType

string

required

The kind of modification type that should result in a notification.

notificationUrl

string

Required for connectionType=HTTP. Callback URL where notifications should be received. Must be HTTPS.

resource

string

required

The path to indicate the resource you want the Webhook subscription for. You must belong to the Tenant and/or Subscription for this, and can only listen to events within your Tenant space.

expirationDateTime

date-time

required

Date and time of Webhook subscription expiration.

brandCode

string

Affiliate code (brandCode).

notificationMessages

string

Required for connectionType=SOCKET. Name of the event to which the client subscribes.

integrityKey

string

If sent, the server generates an HMAC SHA256 hash of the event and attaches it in the HTTP request headers as "integrityHash". The value of this field is used for both client-side and server-side encryption/decryption.

maxRetries

number

Response

201

The Webhook subscription has been successfully created.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://api-sbx.sidedrawersbx.com/api/v1/developers/tenant/tenant-id/tenantId/webhooks?connectionType=HTTP' \
3
     --header 'content-type: application/json' \
4
     --data '
5
{
6
  "modificationType": "Create"
7
}
8
'

Click Try It! to start a request and see the response here!