Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Webhooks

Update a webhook

patch/v0/webhooks/{webhook-id}

Path parameters

webhook-idstring required

Request body

webhook-descriptionstring

A description of the webhook

Example request

{
  "webhook-description": "Griffin API webhook"
}

Response

OK

webhook-descriptionstring

A description of the webhook

updated-atstring date-time

ISO 8601 formatted date-time.

activate-webhook-urlstring required

Activate a webhook

deactivate-webhook-urlstring required

Deactivate a webhook

created-atstring date-time required

ISO 8601 formatted date-time.

webhook-state'inactive' | 'active' required

The state of the webhook.

created-bystring

Link to the user.

organization-urlstring required

Link to the organization.

test-webhook-urlstring required

Test a webhook

webhook-urlstring required

Link to the webhook.

webhook-destination-urlstring required

The callback URL of the webhook (HTTPS on port 443, public IP only)

Example response

{
  "webhook-description": "Griffin API webhook",
  "activate-webhook-url": "/v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/activate",
  "deactivate-webhook-url": "/v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/deactivate",
  "created-by": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  "organization-url": "/v0/organizations/og.IG9yZ2FuaXphdGlvbi1pZA",
  "test-webhook-url": "/v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA/actions/test",
  "webhook-url": "/v0/webhooks/wh.ICAgICAgd2ViaG9vay1pZA",
  "webhook-destination-url": "https://example.com/griffin/webhook/"
}