Create a Webhook

Creates an outbound webhook subscription for a single event type. webhook_url, webhook_name, webhook_event_type, basic_auth_username, basic_auth_secret and hmac_secret are all required. The event type must be one the Developer Partner is entitled to (see GET /api/webhook/v1/supported_event_types) and only one active subscription per event type is allowed. Stored secrets are returned masked.

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

URL for the webhook

string
required

name for the webhook

string

originator identifier for the webhook

string
enum

Status of the webhook

Allowed:
string
enum
required

Type for the webhook event

string
required

basic_auth_username for the webhook

string
required

basic_auth_secret for the webhook

string
required

hmac_secret for the webhook

Responses

400

bad request

401

unauthorized request

403

forbidden - wrong library for event type

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