Skip to content

mail_webhook_create

Register a webhook endpoint for the current product.

Tool

mail_webhook_create

Register a webhook endpoint for the current product.

Register a webhook endpoint for the current product. Returns the signing secret ONCE.

Behavior

HTTP
POST /mail/webhooks

Arguments

Name
Type
Required
Description
url
string
•
HTTPS URL that signed events are POSTed to; plain http is rejected
description
string
—
Optional human label for the endpoint, e.g. "billing service"
enabled_events
array
•
Event types to deliver; at least one. One or more of: email.delivered, email.bounced, email.complained, email.suppressed, email.opened, email.clicked

Response

Field
Type
Always
Description
id
string
•
Webhook endpoint id
url
string
•
HTTPS URL that signed events are POSTed to
secret
string
•
Signing secret for verifying the delivery signature. Returned only when the endpoint is created and never retrievable again — store it now
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

Register a webhook endpoint for the current product.

When to use

Register a webhook endpoint for the current product. Returns the signing secret ONCE.

Example

Ask your agent something like this:

Register a webhook endpoint for the current product.

The agent will invoke mail_webhook_create with these arguments:

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

Esc

Start typing to search the docs.

↑↓navigate↵select