GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Create a Webhook

post
https://na1.ironcladapp.com/public/api/v1/webhooks

Creates a webhook for the specified events. Send separate requests if you need to create webhooks for multiple target URLs. Each target URL may only have one active registration.

OAuth Scope required: public.webhooks.createWebhooks

Body Params
events
array of objects
required
length ≥ 1

The event type(s) to trigger the webhook. Note: you can use * to receive events for all events, although we don't recommend this path, especially for environments with higher volume.

events*
string
required

The URL to send the webhook event payload to. It must be an HTTPS url.

string
enum
Defaults to enabled

The status of the webhook. If the status is disabled, the webhook will not be triggered.

Allowed:
Headers
string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Updated 7 months ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago