Update Webhook subscription

put

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

Updates a webhook subscription.

Path Params

tenantId

string

required

Tenant identifier.

webhookId

string

required

Query Params

connectionType

string

enum

Defaults to HTTP

Connection type (OAuth2, API_KEY, etc.).

Allowed:

Body Params

modificationType

string

enum

Modification type.

Allowed:

notificationUrl

string

Callback URL to nofify about the change.

resource

string

Resource path.

expirationDateTime

date-time

Expiration Date Time.

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

notificationMessages

string

Notification message.

integrityKey

string

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

basicAuth

string

base64. If present, the server attaches "Authorization: Basic {value}" header in each HTTP request.

maxRetries

number

customWorkflow

boolean

Custom workflow.

businessEvents

array of strings

For customWorkflow type subscriptions. List of businessEvents to which to subscribe.

businessEvents

Response

201

The Webhook subscription has been successfully updated.