observe_webhooks_create
Register an HTTPS endpoint to receive this product’s observe issue events, and mint its signing secret.
Register an HTTPS endpoint to receive this product’s observe issue events, and mint its signing secret. The secret is returned here and NOWHERE ELSE — store it now: it cannot be read back and can only be replaced by rotating it. Plain http:// endpoints are rejected.
Behavior
- HTTP
POST /observe/webhooks
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
| url | string | • | HTTPS endpoint the event is POSTed to. Plain http:// is rejected |
| description | string | — | Free-form note about what this endpoint is for, up to 1000 characters |
Response
| Field | Type | Always | Description |
|---|---|---|---|
| id | string | • | Identifier of the endpoint |
| url | string | • | HTTPS endpoint events are POSTed to |
| active | boolean | • | Whether deliveries are being attempted for it |
| secret | string | • | The signing secret — shown only here, store it now; it cannot be read back |
| createdAt | string | • | ISO 8601 registration timestamp |
| updatedAt | string | • | ISO 8601 timestamp of the last change |
| description | string | • | Free-form note given at registration, or null |
Try it
Register an HTTPS endpoint to receive this product’s observe issue events, and mint its signing secret.