Skip to content

Support

support_webhook_get

Get one registered endpoint by id.

Tool

support_webhook_get

Get one registered endpoint by id.

Get one registered endpoint by id. The signing secret is not part of the answer. An endpoint belonging to another product is reported as not found

Behavior

HTTP
GET /support/webhooks/:id

Arguments

NameTypeRequiredDescription
idstringWebhook id

Response

FieldTypeAlwaysDescription
idstringWebhook id
urlstringHTTPS endpoint events are POSTed to
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

Get one registered endpoint by id.

When to use

Get one registered endpoint by id. The signing secret is not part of the answer. An endpoint belonging to another product is reported as not found

Example

Ask your agent something like this:

Get one registered endpoint by id.

The agent will invoke support_webhook_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect