Skip to content

mail_webhook_get

Get a webhook endpoint by id (secret omitted).

Tool

mail_webhook_get

Get a webhook endpoint by id (secret omitted).

Get a webhook endpoint by id (secret omitted).

Behavior

HTTP
GET /mail/webhooks/:id

Arguments

Name
Type
Required
Description
id
string
•
Webhook endpoint id

Response

Field
Type
Always
Description
id
string
•
Webhook endpoint id
url
string
•
HTTPS URL that signed events are POSTed to
enabled
boolean
•
False if delivery is switched off — the endpoint is kept but nothing is sent to it
created_at
string
•
When the endpoint was registered (ISO 8601 UTC)
updated_at
string
•
When the endpoint was last changed (ISO 8601 UTC)
description
string
•
Human label for the endpoint; null if none was given
enabled_events
array
•
Event types this endpoint receives; anything else is not delivered to it

Try it

Get a webhook endpoint by id (secret omitted).

When to use

Get a webhook endpoint by id (secret omitted).

Example

Ask your agent something like this:

Get a webhook endpoint by id (secret omitted).

The agent will invoke mail_webhook_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select