project-webhooks

Update a project webhook

Changed on

Partially update URL, events, or enabled flag.

patch/projects/{project_id}/webhooks/{webhook_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/projects/{project_id}/webhooks/{webhook_id}
  • Auth
    none declared

Path parameters

project_idstring uuid required
webhook_idstring uuid required

Request body

urlstring nullable

HTTPS destination URL.

eventsWebhookEvent[] nullable

Events that should trigger delivery.

enabledboolean nullable

Whether the webhook is active.

Response

Successful Response

idstring required
project_idstring required
organization_idstring required
urlstring required
eventsstring[] required
enabledboolean required
consecutive_failuresinteger
disabled_reasonstring nullable
created_bystring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

    • breaking

      for the path request parameter project_id, the format changed from no format to uuid

    • breaking

      for the path request parameter webhook_id, the format changed from no format to uuid