openapi: 3.2.0 info: version: 1.0.0 title: Customer.io App API description: 'Our App API provides ways to trigger messages and retrieve information about people, campaigns, broadcasts, and more. # Overview The App API provides methods to send newsletters, transactional messages, and API-triggered broadcasts. You can create newsletters from scratch and update transactional messages and API-triggered broadcasts. For transactional messages and API-triggered broadcasts, your payload acts as a message "trigger" and can contain `data` that you reference in your messages using liquid—`{{trigger.}}`. The other endpoints help you retrieve information about people, segments, campaigns, broadcasts, etc; it also lets you update campaign actions, messages, newsletter variants, etc. Aside from the [API-triggered broadcast](#triggerBroadcast) (1 per 10 seconds) and [Transactional](#sendEmail) (100 per second) endpoints, requests are limited to 10 per second. # Use our Postman collection We''ve generated a Postman collection to help you get started with our APIs. If you fork this collection, you might want to disable the *Watch original collection* option. We automatically update our Postman collection whenever we release changes to our documentation, even if we don''t change our APIs—which happens daily! Rather than being flooded with Postman notifications, you can check out our [Release Notes](/release-notes/) for updates to our APIs. **NOTE**: Postman endpoints default to our US APIs. If you''re in our European (EU) region, you''ll need to add `-eu` to the server variables (`track_api_url` and `app_api_url`). [Run In Postman](https://god.gw.postman.com/run-collection/23697545-2931c004-e63d-4cdc-bf4b-e685ba6da42d?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D23697545-2931c004-e63d-4cdc-bf4b-e685ba6da42d%26entityType%3Dcollection%26workspaceId%3Db886877f-fc09-475f-84fe-6221a98f4d18#?env%5BCustomer.io%20API%20Environment%5D=W3sia2V5IjoidHJhY2tfYXBpX3VybCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiJ0cmFjay5jdXN0b21lci5pbyIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYXBwX2FwaV91cmwiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiYXBpLmN1c3RvbWVyLmlvIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzaXRlX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYXBpX2tleSIsInR5cGUiOiJzZWNyZXQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYmVhcmVyIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiYnJvYWRjYXN0X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaW1wb3J0X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiZW1haWxfYWRkcmVzcyIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InN1cHByZXNzaW9uX3R5cGUiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjb2xsZWN0aW9uX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoic25pcHBldF9uYW1lIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5Ijoid2ViaG9va19pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InNlbmRlcl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImV4cG9ydF9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6Im1lc3NhZ2VfaWQiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJzZWdtZW50X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoibmV3c2xldHRlcl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImNvbnRlbnRfaWQiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJjYW1wYWlnbl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImFjdGlvbl9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImN1c3RvbWVyX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoidHJhbnNhY3Rpb25hbF9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6InRyaWdnZXJfaWQiLCJ0eXBlIjoiZGVmYXVsdCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZX0seyJrZXkiOiJmb3JtX2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9LHsia2V5IjoiaWRlbnRpZmllciIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImRldmljZV9pZCIsInR5cGUiOiJkZWZhdWx0IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlfSx7ImtleSI6ImRlbGl2ZXJ5X2lkIiwidHlwZSI6ImRlZmF1bHQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWV9XQ==) # Server addresses: US and EU Customer.io hosts services in the United States (US) and European Union. Select the appropriate server address for your region. | Region | Server Address | | :-- | :-- | | US | https://api.customer.io | | EU | https://api-eu.customer.io | # Authentication All requests to the Customer.io App API use an [App API Key](#App-API-Key). To authenticate, provide your key as a Bearer token in a HTTP Authorization header. You can create and manage your API keys—including keys with different scopes—in [your account settings page](https://fly.customer.io/settings/api_credentials?keyType=app). Each operation on this page references the authorization header it requires. # Rate Limits Most endpoints on this page are limited to 10 requests per second. The exceptions are: * The [transactional email](#operation/sendEmail) endpoint is limited to 100 requests per second. * The [API-triggered broadcast endpoint](#operation/triggerBroadcast) is limited to 1 request every 10 seconds. **Rate limits are subject to change. We may adjust these thresholds to ensure stable performance for all customers.** ' servers: - url: https://api.customer.io description: The base URL for broadcasts, transactional messages, and data-retrieval APIs. These endpoints use bearer authorization, and require a [token that you generate in the UI](https://fly.customer.io/settings/api_credentials?keyType=app). - url: https://api-eu.customer.io description: The base URL for broadcasts, transactional messages, and data-retrieval APIs (EU region). These endpoints use bearer authorization, and require a [token that you generate in the UI](https://fly.customer.io/settings/api_credentials?keyType=app). tags: - name: Customer.io App API paths: {} webhooks: reportingWebhook: post: summary: Reporting webhook format description: 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). operationId: reportingWebhook security: [] parameters: - name: x-cio-timestamp schema: type: integer format: unix timestamp description: The timestamp when the request was sent. in: header required: true - name: x-cio-signature in: header description: "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](/webhooks#securely-verifying-requests). \n" required: true schema: type: string responses: {} requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/customer_event' - $ref: '#/components/schemas/email_event' - $ref: '#/components/schemas/push_event' - $ref: '#/components/schemas/in_app_event' - $ref: '#/components/schemas/sms_event' - $ref: '#/components/schemas/slack_event' - $ref: '#/components/schemas/webhook_event' - $ref: '#/components/schemas/whatsapp_event' examples: customer_subscribed: summary: Customer subscribed event value: metric: subscribed event_id: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: customer timestamp: 1613063089 data: customer_id: '0200000001' email_address: test@example.com identifiers: id: '42' email: test@example.com cio_id: d9c106000001 email_sent: summary: Email sent event value: metric: sent event_id: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: email timestamp: 1613063089 data: action_id: 42 broadcast_id: 9 customer_id: '0200000001' delivery_id: RPILAgUBcRhIBqSfeiIwdIYJKxTY identifiers: id: '42' email: test@example.com cio_id: d9c106000001 recipient: test@example.com sms_sent: summary: SMS sent event value: metric: sent event_id: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: sms timestamp: 1613063089 data: action_id: 42 broadcast_id: 9 customer_id: '0200000001' delivery_id: RPILAgUBcRhIBqSfeiIwdIYJKxTY identifiers: id: '42' email: test@example.com cio_id: d9c106000001 recipient: '+15551234567' tags: - Customer.io App API components: schemas: whatsapp_attempted: title: WhatsApp attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: A WhatsApp message could not be sent to the delivery provider, but will retry. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! sms_sent: title: SMS sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: An SMS notification was sent. If you enabled the *Body Content* option with your webhook, the payload includes the `content` of your message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: content: type: string description: The body of your message. This key only appears if you enabled the *Body Content* option when setting up your webhook. recipient: type: string description: The MSISDN (phone number) of the SMS recipient. webhook_sent: title: Webhook sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - webhook description: The event relates to a webhook. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: content: type: string description: The stringified payload sent to your webhook address. This key only appears if you enabled the *Body Content* option when setting up your webhook. recipient: type: string description: The URL the webhook was sent to. webhook_clicked: title: Webhook clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - webhook description: The event relates to a webhook. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: The webhook recipient opened a tracked link in the webhook payload. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - link_id - href properties: recipient: type: string description: The URL the webhook was sent to. href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 email_sent: title: Email sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: A message was successfully sent. If you enabled the *Include body content and headers in all Sent events* option, the payload includes the `content` of your message and, for emails with custom headers, a `data.headers` object alongside `content`. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject properties: content: type: string description: The body content of your email. This key only appears if you enabled the *Include body content and headers in all Sent events* (*Body Content*) option when setting up your webhook. headers: type: object description: The headers sent with your email, as a map of header name to an array of values. This key only appears if you enabled the *Include body content and headers in all Sent events* (*Body Content*) option when setting up your webhook and the message included custom headers. This is a sibling of `content`—it is not nested inside it. additionalProperties: type: array items: type: string example: Customheader1: - customvalue1 subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com email_delivered: title: Email delivered allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - delivered description: A message was successfully delivered to a recipient. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com push_opened: title: Push opened allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - opened description: A device opened a push notification. data: allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients properties: recipients: type: array items: type: object required: - device_id description: Describes the device of the recipient who clicked/tapped the link. properties: device_id: type: string description: The device identifier/token. device_platform: x-scalar-ignore: true type: string enum: - android - ios description: The device's operating system. example: ios sms_clicked: title: SMS clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: A recipient tapped a link in an SMS message they received. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - link_id - href properties: recipient: type: string description: The MSISDN (phone number) of the SMS recipient. link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io in_app_clicked: title: In-app clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: 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](/journeys/channels/in-app/metrics/#tracked-responses). data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - link_id - href properties: tracked_response: type: string description: The *Action Name* of the action a person clicked/tapped in the message. [Learn more about tracked responses and action names](/journeys/channels/in-app/metrics/#tracked-responses). recipient: type: string description: The ID or email address of the person the message was sent to. This identifier is determined by the settings in your message and the value you use to identify your app's users. href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 slack_attempted: title: Slack attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - slack description: The event relates to a Slack message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: A slack message failed and will be retried. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! webhook_drafted: title: Webhook drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - webhook description: The event relates to a webhook. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - drafted description: A webhook draft was created. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 email_unsubscribed: title: Email unsubscribed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - unsubscribed description: The recipient unsubscribed based on a particular message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com email_spammed: title: Email spammed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - spammed description: A recipient marked an email as spam. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com slack_clicked: title: Slack clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - slack description: The event relates to a Slack message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: A person clicked a tracked link in a Slack message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - href - link_id properties: recipient: type: string description: The channel or person that received the message, i.e. `#general`. href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 slack_failed: title: Slack failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - slack description: The event relates to a Slack message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: A slack message failed. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! email_undeliverable: title: Email undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject - failure_message properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! push_event: title: Push x-scalar-ignore: true description: Events representing a push notification. oneOf: - $ref: '#/components/schemas/push_drafted' - $ref: '#/components/schemas/push_attempted' - $ref: '#/components/schemas/push_delivered' - $ref: '#/components/schemas/push_sent' - $ref: '#/components/schemas/push_opened' - $ref: '#/components/schemas/push_clicked' - $ref: '#/components/schemas/push_converted' - $ref: '#/components/schemas/push_bounced' - $ref: '#/components/schemas/push_dropped' - $ref: '#/components/schemas/push_failed' - $ref: '#/components/schemas/push_undeliverable' discriminator: propertyName: metric in_app_drafted: title: In-app drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - drafted description: An in-app message draft was created. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 whatsapp_drafted: title: WhatsApp drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - drafted description: A WhatsApp message was drafted. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 email_converted: title: Email converted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - converted description: A person matched conversion criteria attributed to an email. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com whatsapp_replied: title: WhatsApp replied description: A person replied to a WhatsApp message you sent them. Customer.io attributes replies to the original delivery if the reply occurs within 72 hours of the original delivery. If the reply occurs outside the 72 hour window, or we can't attribute the reply to a delivery, we won't send this event. allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - replied description: A person replied to a WhatsApp message you sent them. Customer.io attributes replies to the original delivery if the reply occurs within 72 hours of the original delivery. If the reply occurs outside the 72 hour window, or we can't attribute the reply to a delivery, we won't send this event. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - inbound_event_id - to - recipient properties: inbound_event_id: type: string description: The unique identifier for the inbound event. to: type: string description: The phone number the person replied to. (The `sender` of the original message.) recipient: type: string description: The phone number of the person who sent the inbound message. whatsapp_sent: title: WhatsApp sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: A WhatsApp message was sent. If you enabled the *Body Content* option with your webhook, the payload includes the `content` of your message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: content: type: string description: The body of your message. This key only appears if you enabled the *Body Content* option when setting up your webhook. recipient: type: string description: The phone number of the WhatsApp recipient. sms_replied: title: SMS replied description: A person replied to a message you sent them. Customer.io attributes replies to the original delivery if the reply occurs within 72 hours of the original delivery. If the reply occurs outside the 72 hour window, or we can't attribute the reply to a delivery, the `delivery_id` and associated data (`campaign_id`, `action_id`, `trigger_event_id`, etc) we won't send this event. allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - replied description: A person replied to a message you sent them. Customer.io attributes replies to the original delivery if the reply occurs within 72 hours of the original delivery. If the reply occurs outside the 72 hour window, or we can't attribute the reply to a delivery, the `delivery_id` and associated data (`campaign_id`, `action_id`, `trigger_event_id`, etc) we won't send this event. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - inbound_event_id - to - recipient properties: inbound_event_id: type: string description: The unique identifier for the inbound event. to: type: string description: The phone number the person replied to. (The `sender` of the original message.) recipient: type: string description: The phone number the person who sent the inbound message. email_clicked: title: Email clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: A tracked link in an email was clicked. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject - href - link_id properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 machine: type: boolean description: If true, the click was generated by a machine. whatsapp_failed: title: WhatsApp failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: A WhatsApp message couldn't be sent to the delivery provider. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! email_bounced: title: Email bounced allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - bounced description: The delivery provider could not deliver an email. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject - failure_message properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! push_bounced: title: Push bounced allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - bounced description: The delivery provider reported at least one invalid device token. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients properties: recipients: type: array items: type: object required: - device_id - device_platform - failure_message description: Describes the device of the recipient who tapped the link. properties: device_id: type: string description: The device identifier/token. device_platform: x-scalar-ignore: true type: string enum: - android - ios description: The device's operating system. example: ios failure_message: type: string description: The reason the push failed for this particular recipient. whatsapp_event: x-scalar-ignore: true title: WhatsApp description: Events pertaining to WhatsApp messages. oneOf: - $ref: '#/components/schemas/whatsapp_drafted' - $ref: '#/components/schemas/whatsapp_attempted' - $ref: '#/components/schemas/whatsapp_sent' - $ref: '#/components/schemas/whatsapp_delivered' - $ref: '#/components/schemas/whatsapp_opened' - $ref: '#/components/schemas/whatsapp_clicked' - $ref: '#/components/schemas/whatsapp_converted' - $ref: '#/components/schemas/whatsapp_bounced' - $ref: '#/components/schemas/whatsapp_dropped' - $ref: '#/components/schemas/whatsapp_failed' - $ref: '#/components/schemas/whatsapp_undeliverable' - $ref: '#/components/schemas/whatsapp_replied' discriminator: propertyName: metric whatsapp_clicked: title: WhatsApp clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: A recipient tapped a link in a WhatsApp message they received. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - link_id - href properties: recipient: type: string description: The phone number of the WhatsApp recipient. link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io sms_attempted: title: SMS attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: An SMS could not be sent to the delivery provider, but will retry. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! sms_bounced: title: SMS bounced allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - bounced description: The delivery provider was unable to deliver an SMS message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! recipient: type: string description: The MSISDN (phone number) of the SMS recipient. sms_undeliverable: title: SMS undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! email_opened: title: Email opened allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - opened description: An email was opened. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com proxied: type: boolean description: If true, the email was fetched by a proxy to hide the user identity, IP address, etc. prefetched: type: boolean description: If true, the email was opened by Gmail, Apple Privacy Protection, or a user agent identified as a machine. synthetic: type: boolean description: If true, Customer.io inferred the open event because we tracked a click event before we registered an open event (and a link in an email can't be clicked without the email being opened). This does not necessarily mean that the open was machine-oriented. The click—and therefore, the open—could have originated from either a machine or a person. webhook_failed: title: Webhook failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - webhook description: The event relates to a webhook. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: A webhook failed to send. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! in_app_attempted: title: In-app attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: An in-app message failed to send, but will be retried. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! sms_converted: title: SMS converted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - converted description: A person matched conversion criteria attributed to an SMS. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: recipient: type: string description: The MSISDN (phone number) of the SMS recipient. whatsapp_undeliverable: title: WhatsApp undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! slack_undeliverable: title: Slack undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - slack description: The event relates to a Slack message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! webhook_undeliverable: title: Webhook undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - webhook description: The event relates to a webhook. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! in_app_event: x-scalar-ignore: true title: In-App Messages description: Events pertaining to in-app messages. oneOf: - $ref: '#/components/schemas/in_app_drafted' - $ref: '#/components/schemas/in_app_attempted' - $ref: '#/components/schemas/in_app_sent' - $ref: '#/components/schemas/in_app_opened' - $ref: '#/components/schemas/in_app_clicked' - $ref: '#/components/schemas/in_app_converted' - $ref: '#/components/schemas/in_app_failed' - $ref: '#/components/schemas/in_app_undeliverable' discriminator: propertyName: metric slack_sent: title: Slack sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - slack description: The event relates to a Slack message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: A slack message was sent. If you enabled the *Body Content* option with your webhook, the payload includes the `content` of your message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: content: type: string description: The of your slack message. This key only appears if you enabled the *Body Content* option when setting up your webhook. recipient: type: string description: The channel or person that received the message, i.e. `#general`. whatsapp_delivered: title: WhatsApp delivered allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - delivered description: A WhatsApp message was delivered to a recipient. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: recipient: type: string description: The phone number of the WhatsApp recipient. push_dropped: title: Push dropped allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - dropped description: A push notification wasn't sent because at least one device token previously bounced. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients properties: recipients: type: array items: type: object required: - device_id - device_platform - failure_message description: Describes the device of the recipient who tapped the link. properties: device_id: type: string description: The device identifier/token. device_platform: x-scalar-ignore: true type: string enum: - android - ios description: The device's operating system. example: ios failure_message: type: string description: The reason the push failed for this particular recipient. slack_drafted: title: Slack drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - slack description: The event relates to a Slack message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - drafted description: A slack message was drafted. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 sms_event: x-scalar-ignore: true title: SMS description: Events pertaining to SMS notifications. oneOf: - $ref: '#/components/schemas/sms_drafted' - $ref: '#/components/schemas/sms_attempted' - $ref: '#/components/schemas/sms_sent' - $ref: '#/components/schemas/sms_delivered' - $ref: '#/components/schemas/sms_clicked' - $ref: '#/components/schemas/sms_converted' - $ref: '#/components/schemas/sms_bounced' - $ref: '#/components/schemas/sms_failed' - $ref: '#/components/schemas/sms_undeliverable' - $ref: '#/components/schemas/sms_replied' discriminator: propertyName: metric push_clicked: title: Push clicked allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - clicked description: A recipient tapped a link in a push notification. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients - href - link_id properties: href: x-scalar-ignore: true type: string description: The URL of the link that a person clicked. example: https://docs.customer.io link_id: x-scalar-ignore: true type: integer description: The identifier for the tracked link that a person clicked or tapped. example: 1 recipients: type: array items: type: object required: - device_id description: Describes the device of the recipient who tapped the link. properties: device_id: type: string description: The device identifier/token. device_platform: type: string description: The device platform—ios or android. enum: - ios - android webhook_attempted: title: Webhook attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - webhook description: The event relates to a webhook. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: A webhook failed to send, but will be retried. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! email_attempted: title: Email attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: An email could not be sent to the delivery provider and will be retried. The `failure_message` provides the reason for the failure. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! sms_drafted: title: SMS drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - drafted description: An SMS notification was drafted. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 in_app_opened: title: In-app opened allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - opened description: 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. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 customer_event: x-scalar-ignore: true title: Customer description: Events that occur when a customer subscribes or unsubscribes from your messages. oneOf: - title: Customer subscribed description: A person subscribed to messages from you—their `unsubscribed` attribute was set to `false`. allOf: - type: object required: - metric properties: metric: type: string enum: - subscribed description: The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed. - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp - data properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - customer - email - sms - push - in_app - slack - webhook - whatsapp description: 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`. example: customer timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 data: description: Contains information about the event, specific to the `object_type` and `metric`. type: object required: - identifiers - customer_id - email_address properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' email_address: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Customer unsubscribed description: A person unsubscribed to messages from you—their `unsubscribed` attribute was set to `true`. allOf: - type: object required: - metric properties: metric: type: string enum: - unsubscribed description: The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed. - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp - data properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - customer - email - sms - push - in_app - slack - webhook - whatsapp description: 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`. example: customer timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 data: description: Contains information about the event, specific to the `object_type` and `metric`. type: object required: - identifiers - customer_id - email_address properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' email_address: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Customer changed subscription preferences description: 'A person changed their subscription preferences through our subscription center or you changed their `cio_subscription_preferences` attribute values. Some fields in the `data` object change based on whether the message that resulted in the change originated from a broadcast, campaign, or newsletter. ' type: object required: - metric - event_id - data - timestamp properties: metric: type: string enum: - cio_subscription_preferences_changed description: The event we're reporting to your webhook endpoint. In this case, a person changed their subscription preferences. event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type_type: type: string enum: - customer - email - sms - push - in_app - slack - webhook - whatsapp description: 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. example: email timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 data: allOf: - type: object description: Contains information about the event, specific to the `object_type` and `metric`. required: - identifiers - customer_id - email_address properties: content: type: string description: If you enable the *Include body content and headers in all Sent events* when you set up your reporting webhook, you'll see this field. It contains the subscription preferences that a person changed in a stringified object format. The `topic_1` key refers to a topic with an ID of `1`; you can get more information about each topic from our [App API](/api/app/#operation/getTopics). example: '{"topics":{"topic_1":true}}' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' email_address: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - x-scalar-ignore: true oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true - title: Campaign type: object required: - campaign_id - delivery_id - action_id properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 email_event: x-scalar-ignore: true title: Email description: Events representing an email. oneOf: - $ref: '#/components/schemas/email_drafted' - $ref: '#/components/schemas/email_attempted' - $ref: '#/components/schemas/email_sent' - $ref: '#/components/schemas/email_delivered' - $ref: '#/components/schemas/email_opened' - $ref: '#/components/schemas/email_clicked' - $ref: '#/components/schemas/email_converted' - $ref: '#/components/schemas/email_unsubscribed' - $ref: '#/components/schemas/email_bounced' - $ref: '#/components/schemas/email_dropped' - $ref: '#/components/schemas/email_spammed' - $ref: '#/components/schemas/email_failed' - $ref: '#/components/schemas/email_undeliverable' discriminator: propertyName: metric whatsapp_dropped: title: WhatsApp dropped allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - dropped description: Customer.io did not send a WhatsApp message because the recipient was suppressed. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! recipient: type: string description: The phone number of the WhatsApp recipient. in_app_converted: title: In-app converted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - converted description: A person matched conversion criteria attributed to an in-app notification. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: recipient: type: string description: The ID or email address of the person the message was sent to. This identifier is determined by the settings in your message and the value you use to identify your app's users. in_app_failed: title: In-app failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: An in-app message failed to send. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! slack_event: x-scalar-ignore: true title: Slack description: Events pertaining to Slack messages. oneOf: - $ref: '#/components/schemas/slack_drafted' - $ref: '#/components/schemas/slack_attempted' - $ref: '#/components/schemas/slack_sent' - $ref: '#/components/schemas/slack_clicked' - $ref: '#/components/schemas/slack_failed' - $ref: '#/components/schemas/slack_undeliverable' discriminator: propertyName: metric push_converted: title: Push converted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - converted description: A person matched conversion criteria attributed to a push notification. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients properties: recipients: type: array items: type: object required: - device_id description: Describes the device of the recipient who tapped the link. properties: device_id: type: string description: The device identifier/token. device_platform: type: string description: The device platform—ios or android. enum: - ios - android whatsapp_converted: title: WhatsApp converted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - converted description: A person matched conversion criteria attributed to a WhatsApp message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: recipient: type: string description: The phone number of the WhatsApp recipient. push_failed: title: Push failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: A push notification couldn't be sent to the delivery provider. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! whatsapp_opened: title: WhatsApp opened allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - opened description: A WhatsApp message was read by the recipient. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: recipient: type: string description: The phone number of the WhatsApp recipient. whatsapp_bounced: title: WhatsApp bounced allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - whatsapp description: The event relates to a WhatsApp message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - bounced description: The delivery provider was unable to deliver a WhatsApp message. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! recipient: type: string description: The phone number of the WhatsApp recipient. push_undeliverable: title: Push undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! sms_delivered: title: SMS delivered allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - delivered description: An SMS notification was delivered to a recipient. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: recipient: type: string description: The MSISDN (phone number) of the SMS recipient. push_attempted: title: Push attempted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: A push notification was attempted but unsuccessful. This generally means that we'll try again. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! sms_failed: title: SMS failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - sms description: The event relates to an SMS message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: An SMS couldn't be sent to the delivery provider. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! push_delivered: title: Push delivered allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - delivered description: A push notification was delivered to a recipient device. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients properties: recipients: type: array items: type: object required: - device_id description: Describes the device the push was sent to. properties: device_id: type: string description: The device identifier/token. device_platform: type: string description: The device platform—ios or android. enum: - ios - android email_failed: title: Email failed allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - failed description: An email couldn't be sent to the delivery provider. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject - failure_message properties: subject: type: string description: The subject of the email. failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! in_app_sent: title: In-app sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - recipient properties: content: type: string description: The body of your message. This key only appears if you enabled the *Body Content* option when setting up your webhook. recipient: type: string description: The ID or email address of the person the message was sent to. This identifier is determined by the settings in your message and the value you use to identify your app's users. email_drafted: title: Email drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - drafted description: The metric recorded by the event. For `customer` events, this is whether the customer explicitly subscribed or unsubscribed. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com push_sent: title: Push sent allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - sent description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipients properties: content: type: string description: The stringified payload for your push notification. This key only appears if you enabled the *Body Content* option when setting up your webhook. recipients: type: array items: type: object required: - device_id description: The person's devices that the push was sent to. Each object in the array represents a device. properties: device_id: type: string description: The device identifier/token. device_platform: type: string description: The device platform—ios or android. enum: - ios - android failure_message: type: string description: If push failed for the device, we'll the list reason it failed. email_dropped: title: Email dropped allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp example: event_id: 01HXYZ1234567890ABCDEF object_type: email timestamp: 1713484800 properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - email description: The event relates to an email action. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - dropped description: Customer.io did not send an email because it was addressed to a person who was suppressed. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. - type: object required: - recipient - subject - failure_message properties: subject: type: string description: The subject of the email. recipient: x-scalar-ignore: true description: The recipient address for an action. type: string example: test@example.com failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! push_drafted: title: Push drafted allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - push description: The event relates to an push notification. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - attempted description: A push notification was drafted. data: x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Transactional message type: object required: - transactional_message_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 transactional_message_id: description: The transactional message template you used for your message. webhook_event: x-scalar-ignore: true title: Webhook description: Events pertaining to webhooks. oneOf: - $ref: '#/components/schemas/webhook_drafted' - $ref: '#/components/schemas/webhook_attempted' - $ref: '#/components/schemas/webhook_sent' - $ref: '#/components/schemas/webhook_clicked' - $ref: '#/components/schemas/webhook_failed' - $ref: '#/components/schemas/webhook_undeliverable' discriminator: propertyName: metric in_app_undeliverable: title: In-app undeliverable allOf: - x-scalar-ignore: true type: object required: - event_id - object_type - timestamp properties: event_id: x-scalar-ignore: true type: string description: The unique ID of the reporting webhook event being sent. example: 01E4C4CT6YDC7Y5M7FE1GWWPQJ object_type: type: string enum: - in_app description: The event relates to an in-app message. timestamp: x-scalar-ignore: true type: integer format: unix timestamp description: The unix timestamp when the event occurred. example: 1613063089 - type: object required: - metric - data properties: metric: type: string enum: - undeliverable description: 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. data: description: Contains information about the event, specific to the `object_type` and `metric`. allOf: - x-scalar-ignore: true example: customer_id: user-123 delivery_id: RPIyMTM6OjEyMzQ= action_id: 42 campaign_id: 7 journey_id: 15 identifiers: id: user-123 oneOf: - title: API triggered broadcast required: - trigger_id - broadcast_id - delivery_id - action_id - identifiers type: object properties: trigger_id: x-scalar-ignore: true type: integer description: The trigger ID returned by the [Trigger Broadcast API](/api/#operation/triggerBroadcast). example: 1 customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 broadcast_id: oneOf: - x-scalar-ignore: true type: integer description: The identifier for a broadcast. example: 2 - type: 'null' journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - title: Campaign type: object required: - campaign_id - delivery_id - action_id - identifiers properties: campaign_id: oneOf: - x-scalar-ignore: true description: The identifier for a campaign. type: integer example: 5 - type: 'null' customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== action_id: x-scalar-ignore: true description: The identifier for an action. type: integer readOnly: true example: 96 journey_id: x-scalar-ignore: true type: string description: The ID for the path a person went through in a Campaign or API Triggered Broadcast workflow. example: 01GW20GXAAXBKZD8J96M8FNV3R identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 parent_action_id: x-scalar-ignore: true type: integer description: The ID of the parent action, if the action occurred within a campaign and has a parent (like a randomized split, etc). example: 1 readOnly: true trigger_event_id: x-scalar-ignore: true type: string description: The id of the event that triggered an event-triggered campaign (not an API-triggered broadcast). example: 21E4C3CT6YDC7Y4N7FE1GWWABC - title: Newsletter type: object required: - newsletter_id - delivery_id - identifiers properties: customer_id: x-scalar-ignore: true type: string deprecated: true description: 'The ID of the person the webhook event occurred to. Blank if the person in question has been deleted. While webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible. ' example: '42' delivery_id: x-scalar-ignore: true type: string description: The instance of a message sent to a person. example: ZAIAAVTJVG0QcCok0-0ZKj6yiQ== newsletter_id: oneOf: - x-scalar-ignore: true description: The identifier for a newsletter. type: integer example: 10 - type: 'null' content_id: x-scalar-ignore: true description: The identifier for a newsletter variant. type: integer example: 3 identifiers: x-scalar-ignore: true type: object description: "The person the event represents. This object contains all of the identifiers available to people in your workspace, even if they aren't set. If your workspace supports multiple identifiers (email and ID), this object contains `id`, `email` (either of which can be null), and `cio_id`. \n\nOtherwise, if your workspace only supports ID, this object just contains the `id` of the person the event represents.\n" required: - id properties: id: x-scalar-ignore: true type: - string - 'null' description: The ID of a customer profile, analogous to a "person" in the UI. If your workspace supports multiple identifiers (email and ID), this value can be null. example: '42' email: x-scalar-ignore: true type: - string - 'null' description: The email address of the customer. example: test@example.com cio_id: type: string description: The canonical identifier for a person, present only if your workspace supports multiple identifiers (email and ID). This value exists to keep a record of a person in your workspace across changes to their other identifiers. example: d9c106000001 - type: object required: - failure_message properties: failure_message: x-scalar-ignore: true type: string description: Indicates the reason that an attempted message failed. example: Something went wrong! securitySchemes: Bearer-Auth: type: http scheme: bearer description: '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](https://fly.customer.io/settings/api_credentials?keyType=app). [Learn more about bearer authorization in Customer.io](/accounts/settings/managing-credentials). ' ServiceAccount-Auth: x-scalar-ignore: true type: http scheme: bearer bearerFormat: sa_live_ description: 'Transactional send endpoints (`/v1/send/email`, `/v1/send/push`, `/v1/send/sms`, `/v1/send/in_app`, `/v1/send/inbox_message`) also accept a service-account bearer token, prefixed with `sa_live_`. Service-account tokens work across workspaces, so you must pass the target workspace as the `X-Workspace-Id` header on each request. Service-account tokens are intended for testing and one-off sends—for example, using the Customer.io CLI with an AI agent like Claude to verify that a transactional message renders correctly before wiring it into your production backend. **For the production integration that triggers the message from your application, use an App API Key instead**: it''s workspace-scoped, easier to rotate, and has a smaller blast radius. Service-account tokens are server-side credentials. Treat them like any API key—keep them in environment variables or a secret manager, and never embed them in client-side code, mobile apps, or other untrusted contexts. ' bearerAuth: type: http scheme: bearer description: API key passed as a Bearer token