v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Update Webhook Event

This endpoint allows you to update a webhook event. You can use the webhook_event_id to update the webhook event's details.

put/v1/webhook-events/{webhook_event_id}

Path parameters

webhook_event_idstring required

The Webhook Event id

Headers

X-BUSINESS-API-KEYstring required

Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Request body

namestring

The name of the webhook event. It is a required field.

urlstring

The URL of the webhook, must be a valid URL with https protocol. This is the URL that the webhook will send the event data to. It is a required field.

event_typesstring[]

The event types that the webhook will listen to. It is a required field.

Example request

{
  "name": "Test Webhook Event"
}

Response

200

idstring required

business_idstring required

namestring required

urlstring required

event_typesstring[] required

created_atstring required

updated_atstring required