Skip to content

Mail

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

NameTypeRequiredDescription
urlstringHTTPS URL that signed events are POSTed to
descriptionstringOptional human label
enabled_eventsarrayEvent types to deliver. One or more of: email.delivered, email.bounced, email.complained, email.suppressed, email.opened, email.clicked

Response

FieldTypeAlwaysDescription
idstring
urlstring
secretstring
enabledboolean
created_atstring
updated_atstring
descriptionstring
enabled_eventsarray

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.

navigateselect