support_webhook_create
Register an HTTPS endpoint to receive Support events for this product, and mint its signing secret.
Register an HTTPS endpoint to receive Support events for this product, and mint its signing secret. The secret is returned here in clear and NOWHERE ELSE — exactly once, so store it now: it cannot be read back and can only be replaced by rotating it. Plain http:// endpoints are rejected
Behavior
- HTTP
POST /support/webhooks
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | • | HTTPS endpoint the event is POSTed to. Plain http:// is rejected |
| eventTypes | array | • | Event types this endpoint subscribes to. One or more of support.message.created, support.thread.status-changed, support.thread.assigned, support.survey.published, support.response.created |
| description | string | — | Free-form note about what this endpoint is for, up to 1000 characters |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| id | string | • | Webhook id |
| url | string | • | HTTPS endpoint events are POSTed to |
| secret | string | • | The signing secret in clear. Shown exactly once, here — store it now; it cannot be read back and can only be replaced by rotating it |
| status | string | • | active or disabled |
| createdAt | string | • | ISO-8601 creation timestamp |
| updatedAt | string | • | ISO-8601 last-update timestamp |
| eventTypes | array | • | Event types this endpoint subscribes to |
| description | string | • | Free-form note, or null |
| secretPrefix | string | • | First characters of the signing secret, to tell endpoints apart. Never the whole secret |
Try it
Register an HTTPS endpoint to receive Support events for this product, and mint its signing secret.