Webhooks

Update a webhook (name/url/events)

Changed on

Changes a webhook's name, URL or subscribed events and returns it. A field left out keeps its value; the signing secret and enabled state are not changed. Whatever it changes, an update needs the access the webhook's events need on create, since a new URL would redirect them.

Requires the webhook.write permission. See Permissions for the roles and API key permissions that include it.

patch/v1/orgs/{orgId}/webhooks/{id}

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

orgIdstring required
idstring required

Request body

eventsstring[]

Replaces the event list, with the names and rules of create. Absent keeps the list as it is. A name outside this list is stored but never delivered (see create); * is not a wildcard.

namestring
urlstring

Response

Updated

eventsstring[] required

The event types this webhook receives. Empty means the four vm events.

idstring required
namestring required
urlstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9685c770a682Revision changes
    • info

      added the new endpoint.deleted enum value to the request property /

    • info

      added the new endpoint.disabled enum value to the request property /

    • info

      added the new endpoint.ready enum value to the request property /