Update a webhook subscription

Update Webhook Subscription

PATCH/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}

Authorization

useraccessKey

Path parameters

workspaceId*Workspace ID

The ID for the workspace.

organizationId*Organization ID

The ID for the organization.

webhookSubscriptionId*WebhookSubscriptionID

The ID for the webhook subscription.

Body

application/json

templatestring

urlstring

signingKeystring

statusWebhookSubscriptionStatus (enum)

activeinactive

Response

200404422

updated

Body

application/json

id*string (uuid)

organizationId*string (uuid)

workspaceId*string (uuid)

service*string

event*string

eventFiltersarray of WebhookEventFilter (object)

templatestring

url*string

signingKeystring

status*WebhookSubscriptionStatus (enum)

activeinactive

createdAtstring (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/workspaces/{workspaceId}/webhook-subscriptions/{webhookSubscriptionId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "service": "text",
  "event": "text",
  "eventFilters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "template": "text",
  "url": "text",
  "signingKey": "text",
  "status": "active",
  "createdAt": "2024-04-29T09:34:39.883Z",
  "updatedAt": "2024-04-29T09:34:39.883Z"
}