Update a Webhook

patch

https://na1.ironcladapp.com/public/api/v1/webhooks/{id}

Update the data associated with a specific webhook.

OAuth Scope required: public.webhooks.updateWebhooks

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier of the webhook

Body Params

events

array of objects

length ≥ 1

The type of events that will trigger a notification to the target URL.

events

Events that can be subscribed to using a webhook.

targetURL

string

The URL of where the notification gets sent.

status

string

enum

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

Allowed:

Headers

x-as-user-email

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.

x-as-user-id

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

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400