Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Webhooks

Update a Webhook

Update the data associated with a specific webhook.

OAuth Scope required: public.webhooks.updateWebhooks

patch/webhooks/{id}

Path parameters

idstring required

The unique identifier of the webhook

Headers

x-as-user-emailstring
Example:jane.doe@test.com

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-idstring
Example:5f0375c4cdc1927a3c5edcd3

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.

Request body

eventsWebhookEvent[]

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

targetURLstring https-url

The URL of where the notification gets sent.

status'enabled' | 'disabled'

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

Example request

{
  "events": [
    "workflow_launched"
  ]
}

Response

200

idstring required

Unique ID of the webhook

eventsWebhookEvent[] required

Array of events to which webhook is subscribed to.

targetURLstring https-url required

Target URL to which the webhook is called.

companyIdstring required

Unique ID of the Ironclad company instance to which the webhook belongs to.

status'enabled' | 'disabled' | 'disabledBySystem' required

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

statusLastUpdatedAtstring date-time

The timestamp of the most recent status change in ISO 8601 format.

statusLastUpdatedBystring

The user or system ID that made the most recent status change.

consecutiveFailureCountnumber required

The number of consecutive failed deliveries of the webhook. After a certain number of consecutive failures over a certain period of time, the webhook will be disabled. See more.

firstConsecutiveFailurestring date-time

The timestamp of the first consecutive failure of the webhook in ISO 8601 format.

Example response

{
  "id": "5928719b30182d3700364a74",
  "events": [
    "workflow_launched"
  ],
  "targetURL": "https://develop.ironcladapp.com",
  "companyId": "5928719b30182d3700364a74",
  "status": "enabled",
  "statusLastUpdatedAt": "2025-01-17T17:51:49.008Z",
  "statusLastUpdatedBy": "system",
  "firstConsecutiveFailure": "2025-01-17T17:51:49.008Z"
}