Region:

Reporting Webhooks

Download OpenAPI specification:Download

Customer.io lets you subscribe to reporting webhooks. This page details the events that we report back to your webhook URL.

Authentication

Bearer Auth

The App API uses a bearer authentication scheme.

You can generate a bearer token, known as an App API Key, with a defined scope in your account settings. Learn more about bearer authorization in Customer.io.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

Reporting webhooks

Set up webhooks to inform an external service about Customer.io events. Webhooks can notify you immediately when customer attributes change or when people open your messages.

Set up webhooks

Log in and go to Data & Integrations > Integrations.
Find and select Reporting Webhooks.
Click Add Reporting Webhook.
Enter the Webhook Endpoint—the URL where you want to receive events. The URL can be either HTTP or HTTPs, but we recommended HTTPS to protect customer information.
Select the events you want to receive.
(Optional) Select the Send Frequency and Body Content options.
- Send Frequency: This determines whether you receive events the first time they happen or every time they happen.
- Body Content: Enable this to include message body content in all of the "Sent" events we send to you.
Click Save and Enable Webhook.

Timeouts and failures

We have a 4 second timeout for calls to your webhook endpoint. If we don't get a successful (2xx) response during those 4 seconds, we retry the webhook over a period of seven days with an exponential backoff. We backlog subsequent webhook calls and won't continue processing them until the timed-out webhook call returns a successful response or the seven day retry period expires.

If your webhook server responds with any of the following status codes, we'll wait for one hour before we retry the failed call. As with timeouts, we use the same exponential backoff for retries and we'll backlog subsequent webhook calls until the failed call returns a successful response.

Error codes: 400, 401, 402, 403, 404, 405, 410, 429, 500, 502, 521.
Error responses: EOF, server misbehaving, connect: connection refused, read: connection reset by peer, tls: failed to verify certificate: x509:

If you have issues with your webhook server and you want to temporarily block our servers, you can look up the current set of IP addresses we use via this API endpoint.

Securely verifying requests

For security purposes, every email webhook is delivered with an X-CIO-Signature header. This signature is generated by combining your webhook signing key with the body of webhook request using a standard HMAC-SHA256 hash. You can find the signing key on the Email Activity Webhook integration page in your account settings. (This is the same page where you enter your webhook endpoint.)

To validate a signed request, first you'll need to retrieve the X-CIO-Timestamp header sent with the webhook request, and the body of the request. Combine the version number, timestamp and body delimited by colons to form a string in the form v0:<timestamp>:<body> (the version number is always v0). Using HMAC-SHA256, hash the string using your webhook signing secret as the hash key. Compare this value to the value of the X-CIO-Signature header sent with the request to confirm that the request originated with Customer.io.

Reporting webhook format Webhook

Customer.io sends events to your webhook URL in the following format. Events are generally organized by object_type—representing the message or Customer.io action (i.e. email, sms, etc)—and the specific metric pertaining to the type (i.e. sent, bounced, etc).

header Parameters

x-cio-timestamp required	integer <unix timestamp> The timestamp when the request was sent.
x-cio-signature required	string A string combining your webhook signing key with the body of webhook request using an HMAC-SHA256 hash, used to help you securely verify requests.

Request Body: application/json

One of

metric required	string Value: "subscribed" The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed.
event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Enum: "customer" "email" "sms" "push" "in_app" "slack" … 1 more The channel that triggered the subscription change. If the subscription change wasn't triggered from a message, or we can't determine which message triggered the change, the `object_type` is `customer`.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
required	object Contains information about the event, specific to the `object_type` and `metric`.

Request samples

Payload

Content type

application/json

Example

{"metric": "subscribed",
"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "customer",
"timestamp": 1613063089,
"data": {"customer_id": "42",
"email_address": "test@example.com",
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

Customer Events

Customer events occur when a a person changes their subscription settings—their unsubscribed or cio_subscription_preferences attributes change. These changes happen without a reference to a message—like when a customer changes a subscription preference in their account information.

Customer subscribed

A person subscribed to messages from you—their unsubscribed attribute was set to false.

metric required	string Value: "subscribed" The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed.
event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Enum: "customer" "email" "sms" "push" "in_app" "slack" … 1 more The channel that triggered the subscription change. If the subscription change wasn't triggered from a message, or we can't determine which message triggered the change, the `object_type` is `customer`.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"metric": "subscribed",
"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "customer",
"timestamp": 1613063089,
"data": {"customer_id": "42",
"email_address": "test@example.com",
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

Customer Unsubscribed

A person unsubscribed to messages from you—their unsubscribed attribute was set to true.

metric required	string Value: "unsubscribed" The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed.
event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Enum: "customer" "email" "sms" "push" "in_app" "slack" … 1 more The channel that triggered the subscription change. If the subscription change wasn't triggered from a message, or we can't determine which message triggered the change, the `object_type` is `customer`.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"metric": "unsubscribed",
"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "customer",
"timestamp": 1613063089,
"data": {"customer_id": "42",
"email_address": "test@example.com",
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

Customer subscription preferences changed

A person changed their subscription preferences—either through our subscription center, or you changed their cio_subscription_preferences attribute values. Learn more about the subscription center.

metric required	string Value: "cio_subscription_preferences_changed" The event we're reporting to your webhook endpoint. In this case, a person changed their subscription preferences.
event_id required	string The unique ID of the reporting webhook event being sent.
required	object Contains information about the event, specific to the `object_type` and `metric`.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
object_type_type	string Enum: "customer" "email" "sms" "push" "in_app" "slack" … 1 more The channel that triggered the change to the person's subscription preferences. If the subscription change wasn't triggered from a message, or we can't determine which message triggered the change, the `object_type` is `customer`. Most subscription changes are triggered by `email` or are `customer` initiated.

{"metric": "cio_subscription_preferences_changed",
"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type_type": "email",
"timestamp": 1613063089,
"data": {"content": "{\"topics\":{\"topic_1\":true}}",
"customer_id": "42",
"email_address": "test@example.com",
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"trigger_id": 1,
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1
}
}

Email Events

Events that occur during the lifecycle of an email delivery. Some events are reported by the delivery provider.

Email Drafted

An email draft was created.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "drafted" The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "drafted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com"
}
}

Email Attempted

An email could not be sent to the email provider. This metric indicates that we will retry to send the email.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" An email could not be sent to the delivery provider and will be retried. The `failure_message` provides the reason for the failure.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Email Sent

A message was successfully sent.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "sent" A message was successfully sent. If you enabled the Body Content option with your webhook, the payload includes the `content` of your message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "sent",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"content": "string",
"subject": "string",
"recipient": "test@example.com"
}
}

Email Delivered

A message was successfully delivered to a recipient.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "delivered" A message was successfully delivered to a recipient.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "delivered",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com"
}
}

Email Opened

An email was opened.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "opened" An email was opened.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "opened",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com",
"proxied": true,
"prefetched": true,
"synthetic": true
}
}

Email Clicked

A tracked link in an email was clicked.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "clicked" A tracked link in an email was clicked.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "clicked",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com",
"href": "https://docs.customer.io",
"link_id": 1,
"machine": true
}
}

Email Converted

A person matched conversion criteria attributed to an email.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "converted" A person matched conversion criteria attributed to an email.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "converted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com"
}
}

Email Unsubscribed

The recipient unsubscribed based on a particular message.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "unsubscribed" The recipient unsubscribed based on a particular message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "unsubscribed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com"
}
}

Email Bounced

The delivery provider could not deliver an email.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "bounced" The delivery provider could not deliver an email.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "bounced",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com",
"failure_message": "Something went wrong!"
}
}

Email Suppressed

Customer.io did not send an email because it was addressed to a person who was suppressed. The metric dropped indicates a suppressed email event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "dropped" Customer.io did not send an email because it was addressed to a person who was suppressed.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "dropped",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com",
"failure_message": "Something went wrong!"
}
}

Email Spammed

A recipient marked an email as spam.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "spammed" A recipient marked an email as spam.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "spammed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com"
}
}

Email Failed

An email couldn't be sent to the delivery provider.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "failed" An email couldn't be sent to the delivery provider.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "failed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"failure_message": "Something went wrong!"
}
}

Email Undeliverable

A message was undeliverable. Undeliverable messages are messages that have:

Hit a message limit
Come from a newsletter that was cancelled or deleted
Are sent from an environment that has delivery disabled (which is something you might do if you’re testing an integration).

If you’re not using message limits, you probably won’t see this event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "email" The event relates to an email action.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "undeliverable" A message was undeliverable. Undeliverable messages are messages that have either hit a message limit, come from a newsletter that was cancelled or deleted, or an environment that has delivery disabled (which is something you might do if you’re testing an integration). If you’re not using message limits, you probably won’t see this event.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "email",
"timestamp": 1613063089,
"metric": "undeliverable",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"subject": "string",
"recipient": "test@example.com",
"failure_message": "Something went wrong!"
}
}

SMS Events

Events that occur during the lifecycle of an SMS delivery. Some events are reported by the delivery provider.

SMS Drafted

An SMS notification was drafted.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "drafted" An SMS notification was drafted.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "drafted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

SMS Attempted

An SMS could not be sent to the delivery provider, but will retry.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" An SMS could not be sent to the delivery provider, but will retry.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

SMS Sent

An SMS notification was sent.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "sent" An SMS notification was sent. If you enabled the Body Content option with your webhook, the payload includes the `content` of your message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "sent",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"content": "string",
"recipient": "string"
}
}

SMS Delivered

An SMS notification was delivered to a recipient.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "delivered" An SMS notification was delivered to a recipient.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "delivered",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipient": "string"
}
}

SMS Clicked

A recipient tapped a link in an SMS message they received.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "clicked" A recipient tapped a link in an SMS message they received.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "clicked",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipient": "string",
"link_id": 1,
"href": "https://docs.customer.io"
}
}

SMS Converted

A person matched conversion criteria attributed to an SMS.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "converted" A person matched conversion criteria attributed to an SMS.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "converted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipient": "string"
}
}

SMS Bounced

The delivery provider was unable to deliver an SMS message.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "bounced" The delivery provider was unable to deliver an SMS message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "bounced",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!",
"recipient": "string"
}
}

SMS Failed

An SMS couldn't be sent to the delivery provider.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "failed" An SMS couldn't be sent to the delivery provider.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "failed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

SMS Undeliverable

A message was undeliverable. Undeliverable messages are messages that have:

Hit a message limit
Come from a newsletter that was cancelled or deleted
Are sent from an environment that has delivery disabled (which is something you might do if you’re testing an integration).

If you’re not using message limits, you probably won’t see this event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "sms" The event relates to an SMS message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "undeliverable" A message was undeliverable. Undeliverable messages are messages that have either hit a message limit, come from a newsletter that was cancelled or deleted, or an environment that has delivery disabled (which is something you might do if you’re testing an integration). If you’re not using message limits, you probably won’t see this event.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "sms",
"timestamp": 1613063089,
"metric": "undeliverable",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Push Notification Events

Events that occur during the lifecycle of an push notification delivery.

Push Drafted

A push notification was drafted.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" A push notification was drafted.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

Push Attempted

A push notification was attempted but unsuccessful. This generally means that we'll try again.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" A push notification was attempted but unsuccessful. This generally means that we'll try again.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Push Sent

A push notification was sent to a recipient.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "sent" A push notification was sent to a recipient. If you enabled the Body Content option with your webhook, the payload includes the `content` of your message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "sent",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"content": "string",
"recipients": [{"device_id": "string",
"device_platform": "ios",
"failure_message": "string"
}
]
}
}

Push Delivered

A push notification was delivered to a recipient.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "delivered" A push notification was delivered to a recipient device.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "delivered",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipients": [{"device_id": "string",
"device_platform": "ios"
}
]
}
}

Push Opened

A device opened a push notification.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "opened" A device opened a push notification.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "opened",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipients": [{"device_id": "string",
"device_platform": "ios"
}
]
}
}

Push Clicked

A recipient tapped a link in a push notification.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "clicked" A recipient tapped a link in a push notification.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "clicked",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"href": "https://docs.customer.io",
"link_id": 1,
"recipients": [{"device_id": "string",
"device_platform": "ios"
}
]
}
}

Push Converted

A person matched conversion criteria attributed to a push notification.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "converted" A person matched conversion criteria attributed to a push notification.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "converted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipients": [{"device_id": "string",
"device_platform": "ios"
}
]
}
}

Push Bounced

The delivery provider reported at least one invalid device token.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "bounced" The delivery provider reported at least one invalid device token.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "bounced",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipients": [{"device_id": "string",
"device_platform": "ios",
"failure_message": "string"
}
]
}
}

Push Dropped

A push notification wasn't sent because at least one device token previously bounced.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "dropped" A push notification wasn't sent because at least one device token previously bounced.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "dropped",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipients": [{"device_id": "string",
"device_platform": "ios",
"failure_message": "string"
}
]
}
}

Push Failed

A push notification couldn't be sent to the delivery provider.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "failed" A push notification couldn't be sent to the delivery provider.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "failed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Push Undeliverable

A message was undeliverable. Undeliverable messages are messages that have:

Hit a message limit
Come from a newsletter that was cancelled or deleted
Are sent from an environment that has delivery disabled (which is something you might do if you’re testing an integration).

If you’re not using message limits, you probably won’t see this event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "push" The event relates to an push notification.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "undeliverable" A message was undeliverable. Undeliverable messages are messages that have either hit a message limit, come from a newsletter that was cancelled or deleted, or an environment that has delivery disabled (which is something you might do if you’re testing an integration). If you’re not using message limits, you probably won’t see this event.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "push",
"timestamp": 1613063089,
"metric": "undeliverable",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

In-App Message Events

Events that occur during the lifecycle of an in-app message.

In-App Drafted

A in-app notification was drafted.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "drafted" An in-app message draft was created.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "drafted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

In-App Attempted

A in-app notification was attempted but unsuccessful. This generally means that we'll try again.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" An in-app message failed to send, but will be retried.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

In-App Sent

A in-app notification was sent to a recipient.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "sent" An in-app message was sent from Customer.io. Because in-app messages are only delivered when a person's app is open, there may be a significant delay between when a message is sent and when it's "opened". If you enabled the Body Content option with your webhook, the payload includes the `content` of your message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "sent",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"content": "string",
"recipient": "string"
}
}

In-App Opened

A device opened a in-app notification.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "opened" A device opened an in-app message. Because messages appear automatically when a person opens your app (to the right page if using page rules), "opened" is essentially an "impression"—a person saw your message.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "opened",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

In-App Clicked

A recipient tapped a link in a in-app notification.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "clicked" The in-app message recipient clicked/tapped a component in a message with Track Clicks enabled. The Track Clicks setting is enabled by default for in-app messages. The payload includes a `tracked_response` key containing the Action Name of the component the person clicked/tapped. Learn more about tracked responses and action names.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "clicked",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"tracked_response": "string",
"recipient": "string",
"href": "https://docs.customer.io",
"link_id": 1
}
}

In-App Converted

A person matched conversion criteria attributed to a in-app notification.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "converted" A person matched conversion criteria attributed to an in-app notification.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "converted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipient": "string"
}
}

In-App Failed

A in-app notification couldn't be sent to the delivery provider.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "failed" An in-app message failed to send.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "failed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

In-App Undeliverable

A message was undeliverable. Undeliverable messages are messages that have:

Hit a message limit
Come from a newsletter that was cancelled or deleted
Are sent from an environment that has delivery disabled (which is something you might do if you’re testing an integration).

If you’re not using message limits, you probably won’t see this event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "in_app" The event relates to an in-app message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "undeliverable" A message was undeliverable. Undeliverable messages are messages that have either hit a message limit, come from a newsletter that was cancelled or deleted, or an environment that has delivery disabled (which is something you might do if you’re testing an integration). If you’re not using message limits, you probably won’t see this event.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "in_app",
"timestamp": 1613063089,
"metric": "undeliverable",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Slack Events

Events generated from a slack message delivery.

Slack Drafted

A slack message was drafted.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "slack" The event relates to a Slack message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "drafted" A slack message was drafted.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "slack",
"timestamp": 1613063089,
"metric": "drafted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

Slack Attempted

A slack message could not be sent and will be retried.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "slack" The event relates to a Slack message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" A slack message failed and will be retried.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "slack",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Slack Sent

A slack message was sent.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "slack" The event relates to a Slack message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "sent" A slack message was sent. If you enabled the Body Content option with your webhook, the payload includes the `content` of your message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "slack",
"timestamp": 1613063089,
"metric": "sent",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"content": "string",
"recipient": "string"
}
}

Slack Clicked

A person clicked a tracked link in a Slack message.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "slack" The event relates to a Slack message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "clicked" A person clicked a tracked link in a Slack message.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "slack",
"timestamp": 1613063089,
"metric": "clicked",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipient": "string",
"href": "https://docs.customer.io",
"link_id": 1
}
}

Slack Failed

A slack message failed.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "slack" The event relates to a Slack message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "failed" A slack message failed.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "slack",
"timestamp": 1613063089,
"metric": "failed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Slack Undeliverable

A message was undeliverable. Undeliverable messages are messages that have:

Hit a message limit
Come from a newsletter that was cancelled or deleted
Are sent from an environment that has delivery disabled (which is something you might do if you’re testing an integration).

If you’re not using message limits, you probably won’t see this event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "slack" The event relates to a Slack message.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "undeliverable" A message was undeliverable. Undeliverable messages are messages that have either hit a message limit, come from a newsletter that was cancelled or deleted, or an environment that has delivery disabled (which is something you might do if you’re testing an integration). If you’re not using message limits, you probably won’t see this event.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "slack",
"timestamp": 1613063089,
"metric": "undeliverable",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Webhook Events

Events that occur as a part of a webhook delivery.

Webhook Drafted

A webhook draft was created.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "webhook" The event relates to a webhook.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "drafted" A webhook draft was created.
required	object

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "webhook",
"timestamp": 1613063089,
"metric": "drafted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
}
}
}

Webhook Attempted

A webhook failed to send, but will be retried.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "webhook" The event relates to a webhook.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "attempted" A webhook failed to send, but will be retried.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "webhook",
"timestamp": 1613063089,
"metric": "attempted",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Webhook Sent

A webhook was sent from Customer.io.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "webhook" The event relates to a webhook.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "sent" A webhook was sent from Customer.io. If you enabled the Body Content option with your webhook, the payload includes the `content` of your webhook.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "webhook",
"timestamp": 1613063089,
"metric": "sent",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"content": "string",
"recipient": "string"
}
}

Webhook Clicked

The webhook recipient opened a tracked link in the webhook payload.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "webhook" The event relates to a webhook.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "clicked" The webhook recipient opened a tracked link in the webhook payload.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "webhook",
"timestamp": 1613063089,
"metric": "clicked",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"recipient": "string",
"href": "https://docs.customer.io",
"link_id": 1
}
}

Webhook Failed

A webhook failed to send.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "webhook" The event relates to a webhook.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "failed" A webhook failed to send.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "webhook",
"timestamp": 1613063089,
"metric": "failed",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}

Webhook Undeliverable

A webhook was undeliverable. Undeliverable webhooks are webhooks that have:

Hit a message limit
Come from a newsletter that was cancelled or deleted
Are sent from an environment that has delivery disabled (which is something you might do if you’re testing an integration).

If you’re not using message limits, you probably won’t see this event.

event_id required	string The unique ID of the reporting webhook event being sent.
object_type required	string Value: "webhook" The event relates to a webhook.
timestamp required	integer <unix timestamp> The unix timestamp when the event occurred.
metric required	string Value: "undeliverable" A webhook/message was undeliverable. Undeliverable messages are messages that have either hit a message limit, come from a newsletter that was cancelled or deleted, or an environment that has delivery disabled (which is something you might do if you’re testing an integration). If you’re not using message limits, you probably won’t see this event.
required	object Contains information about the event, specific to the `object_type` and `metric`.

{"event_id": "01E4C4CT6YDC7Y5M7FE1GWWPQJ",
"object_type": "webhook",
"timestamp": 1613063089,
"metric": "undeliverable",
"data": {"trigger_id": 1,
"customer_id": "42",
"delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==",
"action_id": 96,
"broadcast_id": 2,
"journey_id": "01GW20GXAAXBKZD8J96M8FNV3R",
"parent_action_id": 1,
"identifiers": {"id": "42",
"email": "test@example.com",
"cio_id": "d9c106000001"
},
"failure_message": "Something went wrong!"
}
}