Skip to content

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

Name
Type
Required
Description
id
string
•
Webhook id

Response

Field
Type
Always
Description
id
string
•
Webhook id
url
string
•
HTTPS endpoint events are POSTed to
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

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.

↑↓navigate↵select