API Reference

Create webhook subscription

post
https://{defaultHost}/api/v1/agency/webhook_subscriptions
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Optional name for this webhook subscription

string
enum
required

The event type to subscribe to

Allowed:
string
enum

Delivery mode: immediate (default) or batched

Allowed:
integer
5 to 1440

Batch interval in minutes (5-1440). Only applicable for batched delivery mode. Default: 30

uri
required

The webhook URL where events will be sent

string

Optional HTTP Basic Auth username

string

Optional HTTP Basic Auth password

Responses

401

unauthorized

Updated 11 months ago

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

Updated 11 months ago

Did this page help you?