Skip to main content
POST
/
v1
/
webhooks
Create a webhook endpoint
curl --request POST \
  --url https://api.example.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "payout.paid",
    "payout.failed"
  ],
  "url": "https://example.com/webhooks",
  "enabled": true
}
'
{
  "createdAt": "<string>",
  "enabled": true,
  "events": [],
  "id": "<string>",
  "signingSecret": "whsec_a1b2c3d4e5f6...",
  "signingSecretHint": "ab1f",
  "updatedAt": "<string>",
  "url": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.zuba.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter Auth0 JWT token

Body

application/json
​
events
enum<string>[]
required

Event types to subscribe to

Available options:
payout.processing,
payout.paid,
payout.failed,
payout.cancelled,
webhook.test
Example:
["payout.paid", "payout.failed"]
​
url
string
required

HTTPS URL to receive webhook events

Example:

"https://example.com/webhooks"

​
enabled
boolean
default:true

Whether the endpoint is enabled

Response

Webhook endpoint created. Signing secret is shown only once.

​
createdAt
string
required

Creation timestamp

​
enabled
boolean
required

Whether the endpoint is enabled

​
events
enum<string>[]
required

Subscribed event types

Available options:
payout.processing,
payout.paid,
payout.failed,
payout.cancelled,
webhook.test
​
id
string
required

Endpoint ID

​
signingSecret
string
required

Signing secret (plaintext, shown only once). Use this to verify webhook signatures.

Example:

"whsec_a1b2c3d4e5f6..."

​
signingSecretHint
string
required

Last 4 characters of the signing secret

Example:

"ab1f"

​
updatedAt
string
required

Last update timestamp

​
url
string
required

Webhook URL