Payments API ReferenceOrganization Webhooks

Create webhook endpoint

Path parameters

organizationIdstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
urlstringRequired
Target URL to receive webhooks
secretstringRequired

Endpoint secret (client-provided). Not returned by the API.

namestringOptional<=128 characters
Display name
descriptionstringOptional<=512 characters
Description

Response

idstring
organizationIdstring
urlstring
environmentenum
Allowed values:
isActiveboolean
isDeletedboolean
createdAtstringformat: "date-time"
updatedAtstringformat: "date-time"
namestring or null
descriptionstring or null

Errors