v1

Create Webhook

Create a webhook and send a verification ping.

Save the signing secret from this response; it is returned once. Accounts default to three webhook slots, including unverified and pending ones; your account may have a custom allowance. A ping returning HTTP 200 moves unverified to pending. Contact Ellipsis to activate it and receive session.create events.

post/v1/webhooks

Request

  • Base URL
    https://api.ellipsis.dev
  • URL
    https://api.ellipsis.dev/v1/webhooks
  • Auth
    HTTP bearer

Headers

user-agentstring nullable

Request body

descriptionstring nullable
eventsstring[] required

Explicit event subscriptions. Currently only session.create is supported. Pings are sent independently of subscriptions.

urlstring required

The single public HTTPS URL to receive signed POST requests. Changing it requires verification and approval again.

Example request

{
  "events": [
    "session.create"
  ],
  "url": "https://example.com/hooks"
}

Response

Successful Response

secretstring required

The signing secret, returned only in this creation response. Save it now; it cannot be retrieved later.

Changes

No recorded changes to this operation across all 1 revision of this API.