API Reference
  1. Webhooks
  2. Webhook Management

Subscribe to a webhook

post
https://{domain}/api/main-account/webhooks

Subscribe a URL to receive webhook notifications and get a unique secret for this subscription. Important: This is the only endpoint returning the secret. Make sure not to lose it!

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request for subscribing a webhook endpoint.

string
required
length between 0 and 255

The URI that will be called when the webhook is triggered.

string
enum
required
length between 0 and 10
^(POST|PUT|PATCH)$

The HTTP method to use when calling the webhook.

Allowed:
string | null

Optional description of the webhook's purpose.

string
enum
required

The type of event to subscribe to.

string | null

Optional secret, which is used to verify webhook requests signature. If not provided, a random secret will be generated and returned in the response.

Headers
string
required
length between 0 and 36

A unique client-generated identifier for idempotency. Prevents duplicate requests if the same ID is used more than once.

uuid
required

Main account ID.

string
required

SHA-256 signature of the JSON payload and private key. See API Key Authentication

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated 4 months ago

Did this page help you?