Authorizations
The API key. For more details, refer to API key.
In the API playground, enter your API secret, and your API key will be accordingly calculated.
Path Parameters
The webhook endpoint ID. You can retrieve a list of webhook endpoint IDs by calling List webhook endpoints.
Response
The request was successful.
The information about a webhook endpoint.
The webhook endpoint URL.
500
"https://example.com/webhook"
The event types subscribed by a webhook endpoint.
The time when the endpoint was registered, in Unix timestamp format, measured in seconds.
1701396866000
The webhook endpoint status. Possible values include:
STATUS_ACTIVE
: The endpoint is currently in use.STATUS_INACTIVE
: The endpoint has been revoked and can no longer receive webhook events.STATUS_PENDING_ACTIVE
: The request to create the endpoint is awaiting approval. After the approval, the endpoint will be available for use.STATUS_PENDING_INACTIVE
: The request to revoke the endpoint is awaiting approval. After the approval,the endpoint will no longer receive webhook events.STATUS_PENDING_UPDATE
: The request to update the endpoint is awaiting approval. After the approval, the endpoint will be updated.STATUS_REJECT_ACTIVE
: The request to create the endpoint has been rejected.
STATUS_ACTIVE
, STATUS_INACTIVE
, STATUS_PENDING_ACTIVE
, STATUS_PENDING_INACTIVE
, STATUS_PENDING_UPDATE
, STATUS_REJECT_ACTIVE
"STATUS_ACTIVE"
The webhook endpoint ID.
"8f2e919a-6a7b-4a9b-8c1a-4c0b3f5b8b1f"
The description of the webhook endpoint.
"My webhook endpoint"