POST /webhooks
Create a webhook and send a verification ping.
TypeScript SDKThe npm client, generated from the API spec.Python SDKThe PyPI client, sync and async.
| Method | Path |
|---|---|
| POST | /v1/webhooks |
Save the signing secret from this response; it is returned once. Accounts can have three webhooks, including unverified and pending ones. A ping returning HTTP 200 moves unverified to pending. Contact Ellipsis to activate it and receive session.create events.
curl -X POST "https://api.ellipsis.dev/v1/webhooks" \
-H "Authorization: Bearer $ELLIPSIS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"events": [
"session.create"
],
"url": "https://example.com/hooks"
}'import os
from ellipsis import Ellipsis
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
result = client.webhooks.create(
["session.create"],
"https://example.com/hooks",
)
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const result = await client.webhooks.create(
{ events: ["session.create"], url: "https://example.com/hooks" },
);
console.log(result);Request
Example request body
{
"url": "https://example.com/hooks"
}
Body parameters
descriptionstring
eventsarray<string>required
Explicit event subscriptions. Currently only session.create is supported. Pings are sent independently of subscriptions.
urlstringrequired
The single public HTTPS URL to receive signed POST requests. Changing it requires verification and approval again.
Response
Example response · 201
{
"secret": "string",
}