Webhooks can be created by provinding the below listed parameters.
Setting a webhook secret allows you to ensure that POST
requests sent to the payload URL are from Oyster. When you set a secret, you’ll receive the X-Sfpy-Signature
header in the webhook POST
request.
The events
array allows your webhook to subscribe to events that you’re interested in. Please note however that no two webhooks can be subscribed to the same event. If there is an attempt to create or update a webhook where any one event in the list is already subscribed to by a previosuly created webhook, the API will return an error with status code 409
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The Partner ID header used for authorization
The Idempotency Key - usually a UUID
Request to create a new webhook
The body is of type object
.
Successful retrieval of a webhook subscription
Standard response structure for successful operations