Skip to content

observe_webhooks_create

Register an HTTPS endpoint to receive this product’s observe issue events, and mint its signing secret.

Tool

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

NameTypeRequiredDescription
urlstringHTTPS endpoint the event is POSTed to. Plain http:// is rejected
descriptionstringFree-form note about what this endpoint is for, up to 1000 characters

Response

FieldTypeAlwaysDescription
idstringIdentifier of the endpoint
urlstringHTTPS endpoint events are POSTed to
activebooleanWhether deliveries are being attempted for it
secretstringThe signing secret — shown only here, store it now; it cannot be read back
createdAtstringISO 8601 registration timestamp
updatedAtstringISO 8601 timestamp of the last change
descriptionstringFree-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.

When to use

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.

Example

Ask your agent something like this:

Register an HTTPS endpoint to receive this product’s observe issue events, and mint its signing secret.

The agent will invoke observe_webhooks_create with these arguments:

{
  "url": "<url>"
}

Esc

Start typing to search the docs.

navigateselect