Webhooks

Enable/disable a webhook

Changed on

Sets enabled and returns the new state. A disabled webhook keeps its URL, events and secret but gets no deliveries. A retry that comes due while it is disabled is dropped.

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

post/v1/orgs/{orgId}/webhooks/{id}/toggle

Request

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

Path parameters

orgIdstring required
idstring required

Request body

enabledboolean required

Response

Toggled

enabledboolean required
idstring 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

  • 12b2fcbcc298Revision 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

    • 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

    • info

      added the optional property to the response with the status