/webhooks

post

https://api.dev.orbit.do/v5/webhooks

Register a webhook: a target URL, the events to deliver, optional per-event filters and how deliveries authenticate. Secrets are stored write-only and returned masked. See the Webhooks guide for event payloads, filters and delivery semantics.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Webhook to create.

name

string

required

length ≥ 1

Human-readable label for this webhook subscription.

targetUrl

uri

required

length ≥ 1

^https://

HTTPS URL that receives a POST for each enabled event. Must be a valid absolute URL using the https:// scheme — deliveries carry credentials, so plaintext schemes are rejected.

enabledEvents

array

required

length ≥ 1

Event types this webhook is subscribed to; at least one is required. A delivery fires only for events named here.

enabledEvents*

event

string

enum

required

filter

object

Optional rule group restricting which events of this type are delivered: a nested rule/group tree joined by and/or, matched against the event payload. Absent means every event of this type is delivered.

authDetails

How outgoing deliveries are authenticated. 'None' sends no auth; 'Basic' sends a user name and password in the Authorization header; 'Bearer' sends a token in the Authorization header; 'HMAC' leaves the Authorization header alone and instead signs each payload with the shared secret, sending the signature in its own headers. Defaults to no authentication when omitted. Credential fields must be non-empty.

Responses

400

Bad request - invalid target URL, unknown event, filter referencing a field the event does not carry, or blank credentials

401

Unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created webhook (secrets masked)