POST /webhooks
Updated Oct 1, 20261 minute read
Add a webhook
Points events at a URL of yours. Deliveries sign with material derived from the Median key that made the request, or the newest one for an OAuth token, so adding an endpoint creates no new credential. HTTPS on a public address only: localhost, private addresses and URLs with credentials answer invalid_url.
Part of Webhooks.
Request body
application/json, required.
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
events | "message.created" | "conversation.created" | "conversation.updated" | "bug.created" | "suggestion.created" | "signal.updated" | "knowledge.suggestion.created"[] | Yes |
Responses
| Status | Description |
|---|---|
200 | Created. |
400 | The request is malformed, and the message names the field. |
401 | The bearer token is missing, revoked, or expired. |
403 | The token's person does not hold the role this needs. |
429 | Too many requests. Wait the seconds in Retry-After. Limits depend on the plan. See rate limits. |
200 body
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No |
Example request
curl -X POST https://api.median.sh/v1/webhooks \
-H "Authorization: Bearer $BEARER_AUTH" \
-H "content-type: application/json" \
-d '{"url":"https://example.com/median/events","events":["message.created"]}'