Sign in
Reporting Webhooks

Create a reporting webhook

Create a new webhook configuration.

post/v1/reporting_webhooks

Request body

namestring required

The name of your webhook.

idinteger

The identifier for the webhook.

type'webhook' | 'js'

The type of webhook—webhook for a standard reporting webhook or js for a JavaScript webhook.

endpointstring url required

The webhook URL.

disabledboolean

Set to true to quit sending events to the webhook URL. Set to false to enable the webhook.

full_resolutionboolean

Set to false to send unique open and click events to the webhook. Set to true to send all events.

with_contentboolean

Set to true to include the message body in _sent events.

eventsstring[] required

Specifies the types of events you want to report to your webhook. See our reporting webhooks reference for more information about event types and the information they return.

Example request

{
  "name": "my cool webhook",
  "id": 4,
  "type": "webhook",
  "endpoint": "https://example.com/webhook",
  "full_resolution": true,
  "events": [
    "email_failed",
    "webhook_failed"
  ]
}

Response

Returns your webhook configuration and the ID of the webhook.

namestring required

The name of your webhook.

idinteger

The identifier for the webhook.

type'webhook' | 'js'

The type of webhook—webhook for a standard reporting webhook or js for a JavaScript webhook.

endpointstring url required

The webhook URL.

disabledboolean

Set to true to quit sending events to the webhook URL. Set to false to enable the webhook.

full_resolutionboolean

Set to false to send unique open and click events to the webhook. Set to true to send all events.

with_contentboolean

Set to true to include the message body in _sent events.

eventsstring[] required

Specifies the types of events you want to report to your webhook. See our reporting webhooks reference for more information about event types and the information they return.

Example response

{
  "name": "my cool webhook",
  "id": 4,
  "type": "webhook",
  "endpoint": "https://example.com/webhook",
  "full_resolution": true,
  "events": [
    "email_failed",
    "webhook_failed"
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.