Skip to content

Support

support_webhook_create

Register an HTTPS endpoint to receive Support events for this product, and mint its signing secret.

Tool

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

NameTypeRequiredDescription
urlstringHTTPS endpoint the event is POSTed to. Plain http:// is rejected
eventTypesarrayEvent 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
descriptionstringFree-form note about what this endpoint is for, up to 1000 characters

Response

FieldTypeAlwaysDescription
idstringWebhook id
urlstringHTTPS endpoint events are POSTed to
secretstringThe signing secret in clear. Shown exactly once, here — store it now; it cannot be read back and can only be replaced by rotating it
statusstringactive or disabled
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-update timestamp
eventTypesarrayEvent types this endpoint subscribes to
descriptionstringFree-form note, or null
secretPrefixstringFirst 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.

When to use

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

Example

Ask your agent something like this:

Register an HTTPS endpoint to receive Support events for this product, and mint its signing secret.

The agent will invoke support_webhook_create with these arguments:

{
  "url": "<url>",
  "eventTypes": "<eventTypes>"
}

Esc

Start typing to search the docs.

navigateselect