Loading...
API Reference
Webhooks

Manage webhook subscriptions to receive real-time notifications for checkout and order events

# Endpoints
put
/webhook/{id}
Update an existing webhook subscription. All fields are optional - only provided fields will be updated.
del
/webhook/{id}
Permanently delete a webhook subscription. This action cannot be undone.
get
/webhook/{id}
Retrieve details of a specific webhook subscription by ID
get
/webhook
Retrieve a paginated list of webhook subscriptions for the authenticated platform. Supports filtering by active status and event type.
post
/webhook
Create a new webhook subscription to receive event notifications at the specified URL. The webhook secret is returned only once upon creation and should be stored securely for signature verification.
put
Update Webhook

Update an existing webhook subscription. All fields are optional - only provided fields will be updated.

Parameters
id
string
required
Webhook ID (UUID format)
Request body
active
boolean
Enable/disable webhook
description
string
New description (optional)
events
string[]
New event types (optional)
url
string
New URL (optional)
put
/webhook/{id}
shell
javascript
go
java
php
{} Response
200
400
401
404
409
500
del
Delete Webhook

Permanently delete a webhook subscription. This action cannot be undone.

Parameters
id
string
required
Webhook ID (UUID format)
del
/webhook/{id}
shell
javascript
go
java
php
{} Response
200
400
401
404
500
get
Get Webhook

Retrieve details of a specific webhook subscription by ID

Parameters
id
string
required
Webhook ID (UUID format)
get
/webhook/{id}
shell
javascript
go
java
php
{} Response
200
400
401
404
500
get
List Webhooks

Retrieve a paginated list of webhook subscriptions for the authenticated platform. Supports filtering by active status and event type.

Parameters
limit
integer
Number of results to return (default: 20, max: 100)
offset
integer
Pagination offset (default: 0)
get
/webhook
shell
javascript
go
java
php
{} Response
200
400
401
500
post
Create Webhook

Create a new webhook subscription to receive event notifications at the specified URL. The webhook secret is returned only once upon creation and should be stored securely for signature verification.

Request body
description
string
Optional description
events
string[]
required
Event types to subscribe to
url
string
required
HTTPS URL to receive webhook events
post
/webhook
shell
javascript
go
java
php
{} Response
201
400
401
409
500
put
/webhook/{id}
shell
javascript
go
java
php
{} Response
200
400
401
404
409
500