Webhooks

Create a webhook (secret returned once)

Changed on

Registers an HTTPS URL for the events you list and returns the webhook with its whsec_ signing secret, the only time that secret is returned. Each delivery is a signed POST of {id, type, created_at, data}. Listing a batch event needs batch read access and a balance event billing read access, beside webhook write access (403 otherwise). A name the platform sends no event for is stored and never delivered.

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

post/v1/orgs/{orgId}/webhooks/create

Request

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

Path parameters

orgIdstring required

Request body

eventsstring[]

The event types to deliver: vm.running, vm.stopped, vm.terminated, vm.interrupted, batch.completed, batch.failed, batch.expired, batch.cancelled, balance.low, balance.depleted, endpoint.ready, endpoint.disabled and endpoint.deleted. Empty or absent delivers the four vm events; a batch, balance or endpoint event reaches only a webhook that lists it. Listing a batch event also needs batch read access, a balance event billing read access, and an endpoint event endpoint read access. A name outside this list is stored but never delivered: the server does not reject it, so an existing webhook may carry one from before this list existed. * is not a wildcard; it matches nothing.

namestring required
urlstring required

Response

Created

createdAtstring required
enabledboolean required
eventsstring[] required

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

idstring required
namestring required
secretstring required
secretPrefixstring 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

  • 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 /