Update a Webhook subscription

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

Updates an existing Webhook subscription.

Path Params

tenantId

string

required

Unique Tenant identifier.

webhookId

string

required

Unique Webhook identifier.

Query Params

connectionType

string

Defaults to HTTP

Communication protocol: HTTP or SOCKET. Default: HTTP.

Body Params

modificationType

string

Modification type.

notificationUrl

string

Required for connectionType=HTTP. Callback URL to notify about the change. Must be HTTPS.

resource

string

Resource path

expirationDateTime

date-time

Date and time of 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 updated.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request PUT \
2
     --url 'https://api-sbx.sidedrawersbx.com/api/v1/developers/tenant/tenant-id/tenantId/webhooks/webhook-id/webhookId?connectionType=HTTP' \
3
     --header 'content-type: application/json'

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