Skip to main content
POST
/
v1
/
webhooks
Create webhook
curl --request POST \
  --url https://api.adullam.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://mystore.com/webhooks/adullam",
  "events": [
    "payment.completed",
    "payment.failed",
    "transfer.completed"
  ],
  "description": "Production webhook"
}
'
{
  "id": "webhook_abc123",
  "url": "https://mystore.com/webhooks/adullam",
  "events": [
    "payment.completed",
    "payment.failed",
    "transfer.completed"
  ],
  "status": "active",
  "secret": "whsec_abc123def456...",
  "description": "Production webhook",
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-15T10:00:00Z"
}

​
Create Webhook

Registering a new webhook endpoint allows you to receive real-time event notifications from the Adullam platform. Use the Create Webhook API to specify the target URL, subscribed events, and any custom headers required for your webhook.

Authorizations

​
Authorization
string
header
required

Use the access token obtained from /v1/auth/token

Body

application/json
​
url
string<uri>
required
Example:

"https://mystore.com/webhooks/adullam"

​
events
enum<string>[]
required
Minimum array length: 1
Available options:
payment.created,
payment.processing,
payment.completed,
payment.failed,
payment.refunded,
transfer.created,
transfer.processing,
transfer.completed,
transfer.failed,
transfer.reversed
Example:
[
  "payment.completed",
  "payment.failed",
  "transfer.completed"
]
​
description
string
Maximum string length: 200
Example:

"Production webhook"

Response

Webhook created

​
id
string
Example:

"webhook_abc123"

​
url
string<uri>
Example:

"https://mystore.com/webhooks/adullam"

​
events
string[]
Example:
[
  "payment.completed",
  "payment.failed",
  "transfer.completed"
]
​
status
enum<string>
Available options:
active,
inactive
Example:

"active"

​
secret
string

Secret key for webhook signature verification

Example:

"whsec_abc123def456..."

​
description
string
Example:

"Production webhook"

​
created_at
string<date-time>
Example:

"2024-01-15T10:00:00Z"

​
updated_at
string<date-time>
Example:

"2024-01-15T10:00:00Z"