{ "components": { "parameters": { "workspace_id_header": { "x-scalar-ignore": true, "name": "X-Workspace-Id", "in": "header", "required": false, "description": "The numeric ID of the workspace you want to send a message in. This header is only needed when you authenticate with a service-account bearer token (`sa_live_…`). Service accounts work across workspaces, so you must supply this header so we know which workspace to send from. You can omit this header when you authenticate with a standard App API key, which is always scoped to one workspace.\n", "schema": { "type": "integer", "example": 100 } }, "object_type_id": { "name": "object_type_id", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type.", "in": "path", "required": true, "schema": { "type": "integer", "example": 1 } }, "object_id": { "name": "object_id", "description": "The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`.", "in": "path", "required": true, "schema": { "type": "string", "example": "abc123" } }, "suppression_type": { "name": "suppression_type", "description": "The reason a person's email address was suppressed by the email service provider (ESP).", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "blocks", "bounces", "spam_reports", "invalid_emails" ] } }, "transactional_id": { "name": "transactional_id", "description": "The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the path of a transactional message URL - `/transactional/3/templates/139` - the `transactional_id` is 3.", "in": "path", "required": true, "schema": { "type": "integer" } }, "collection_id": { "name": "collection_id", "description": "The identifier for a collection.", "in": "path", "required": true, "schema": { "type": "integer" } }, "delivery_id": { "name": "delivery_id", "description": "The delivery resulting in a request to unsubscribe.", "in": "path", "required": true, "schema": { "type": "string" } }, "activityTypes": { "name": "type", "description": "The type of activity you want to search for. Types with `_o:` are for objects and types with `_r:` are for relationships.", "in": "query", "required": false, "schema": { "x-scalar-ignore": true, "description": "The type of activity. Types with `_o:` are for objects and types with `_r:` are for relationships.", "type": "string", "enum": [ "add_relationship", "anon_merge", "attempted_action", "attempted_email", "attempted_in_app", "attempted_push", "attempted_slack", "attempted_twilio", "attempted_webhook", "attempted_whatsapp", "attribute_change", "bounced_action", "bounced_email", "bounced_push", "bounced_twilio", "bounced_whatsapp", "clicked_action", "clicked_content", "clicked_email", "clicked_in_app", "clicked_push", "clicked_twilio", "clicked_webhook", "converted_action", "converted_content", "converted_email", "converted_in_app", "converted_slack", "converted_twilio", "converted_webhook", "converted_whatsapp", "deferred_action", "deferred_email", "deferred_in_app", "deferred_push", "deferred_slack", "deferred_twilio", "deferred_webhook", "deferred_whatsapp", "delete_relationship", "delivered_action", "delivered_email", "delivered_push", "delivered_twilio", "delivered_whatsapp", "device_change", "drafted_action", "drafted_email", "drafted_in_app", "drafted_push", "drafted_slack", "drafted_twilio", "drafted_webhook", "dropped_action", "dropped_email", "dropped_push", "dropped_twilio", "dropped_webhook", "dropped_whatasapp", "event", "failed_action", "failed_attribute_change", "failed_batch_update", "failed_email", "failed_event", "failed_in_app", "failed_object_journeys", "failed_push", "failed_query_collection", "failed_slack", "failed_twilio", "failed_webhook", "failed_whatsapp", "opened_action", "opened_email", "opened_in_app", "opened_push", "page", "profile_create", "profile_delete", "profile_merge", "relationship_attribute_change", "relationship_failed_attribute_change", "screen", "sent_action", "sent_email", "sent_in_app", "sent_push", "sent_slack", "sent_twilio", "sent_webhook", "sent_whatsapp", "skipped_update", "spammed_email", "suppressed_twilio", "suppressed_whatsapp", "topic_unsubscribed_email", "undeliverable_action", "undeliverable_email", "undeliverable_in_app", "undeliverable_push", "undeliverable_slack", "undeliverable_twilio", "undeliverable_webhook", "undeliverable_whatsapp", "unsubscribed_action", "unsubscribed_email", "viewed_content", "webhook_event", "_o::add_relationship", "_o::attribute_change", "_o::create", "_o::delete", "_o::delete_relationship", "_o::failed_attribute_change", "_r::attribute_change", "_r::failed_attribute_change" ], "example": "sent_email" } }, "sender_id": { "name": "sender_id", "in": "path", "required": true, "description": "The identifier of a sender.", "schema": { "type": "integer" } }, "sort": { "name": "sort", "in": "query", "description": "Determine how you want to sort results, `asc` for chronological order and `desc` for reverse chronological order.", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, "activityName": { "name": "name", "in": "query", "description": "The name of the event or attribute you want to return.", "required": false, "schema": { "type": "string", "example": "something_happened" } }, "deleted": { "name": "deleted", "in": "query", "description": "If true, return results for deleted people.", "required": false, "schema": { "type": "boolean", "default": false } }, "customer_id_query": { "name": "customer_id", "required": false, "in": "query", "description": "The `identifier` of the person you want to look up. By default, this is a person's `id`. You can use the `id_type` parameter to look up a person by `email`, `phone`, or `cio_id`.\n\nIf you use a person's `cio_id`, you must prefix the value with `cio_` when using it to find or reference a person (i.e. `cio_03000010` for a `cio_id` value of 03000010).\n", "schema": { "type": "string" } }, "object_id_type": { "name": "id_type", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "object_id", "cio_object_id" ], "default": "object_id" } }, "id_type": { "name": "id_type", "required": false, "in": "query", "description": "The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in your request is a person's `id`. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace); otherwise the request returns `400`. Reference `phone` values in [E.164 format](https://en.wikipedia.org/wiki/E.164), like `+14155552671`, and URL-encode the leading `+` as `%2B`.", "schema": { "type": "string", "enum": [ "id", "email", "phone", "cio_id" ] } }, "export_id": { "name": "export_id", "in": "path", "required": true, "description": "The export_id you want to access.", "schema": { "type": "integer" } }, "language-1": { "name": "language", "required": false, "in": "query", "description": "A [language tag](/journeys/channels/subscriptions/unsubscribe-faqs/#currently-supported-languages) you want the content translated in. If none is provided, the content will be sent in the default language of your subscription center.", "schema": { "type": "string" } }, "language-2": { "name": "language", "in": "path", "required": true, "description": "A [language tag](/journeys/channels/subscriptions/unsubscribe-faqs/#currently-supported-languages) of a language variant. If you don't provide a language (an empty string), we'll use your default language. If the language variant does not exist, we'll return an error.", "schema": { "type": "string" } }, "newsletter_id": { "name": "newsletter_id", "in": "path", "required": true, "description": "The identifier of a newsletter.", "schema": { "type": "integer" } }, "content_id": { "name": "content_id", "in": "path", "required": true, "description": "The identifier of a message in a newsletter. If your newsletter has an A/B test group or includes multiple languages, each variant has its own `content_id`, separate from the `newsletter_id`.\n\nUse [List variants of a newsletter](/integrations/api/app/tag/newsletter-variants/listNewsletterVariants/) to find the `content_id` associated with the right variant.\n", "schema": { "type": "integer" } }, "webhook_id": { "name": "webhook_id", "in": "path", "required": true, "description": "The identifier of a webhook.", "schema": { "type": "integer" } }, "message_id": { "name": "message_id", "in": "path", "required": true, "description": "The identifier of a message.", "schema": { "type": "string" } }, "campaign_id_query": { "name": "campaign_id", "in": "query", "required": false, "description": "The automation you want to filter for.", "schema": { "type": "integer" } }, "newsletter_id_query": { "name": "newsletter_id", "in": "query", "required": false, "description": "The newsletter you want to filter for.", "schema": { "type": "integer" } }, "action_id_query": { "name": "action_id", "in": "query", "required": false, "description": "The action you want to filter for.", "schema": { "type": "integer" } }, "campaign_id": { "name": "campaign_id", "in": "path", "required": true, "description": "The ID of the automation that you want to trigger or return information about.", "schema": { "type": "integer", "example": 3 } }, "trigger_id": { "name": "trigger_id", "in": "path", "required": true, "description": "The ID of the automation trigger that you want to return information for.", "schema": { "type": "integer", "example": 3 } }, "track_customer_id": { "name": "identifier", "required": true, "in": "path", "description": "The unique value representing a person. The values you use to identify a person may be an `id`, `email` address, or the `cio_id` (when updating people), depending on your workspace settings. When you reference people by `cio_id`, you must prefix the value with `cio_`.\n\nYou can't reference a person by their `phone` number here. We determine the identifier type from the shape of the value, so a phone number in the path is treated as an `id`. To identify people by phone number, use the [Track v2 API](/integrations/api/track/tag/track_v2/).\n", "schema": { "oneOf": [ { "title": "id", "type": "string", "example": 12345, "description": "The unique identifier for a person that you want to create or modify." }, { "title": "email", "type": "string", "example": "person@example.com", "description": "A person's email address. If adding a new person in an email-based workspace, you must use this value." }, { "title": "cio_id", "type": "string", "format": "cio_[a-zA-Z0-9]*", "description": "A canonical identifier assigned by Customer.io when you add a person. When referencing a person by this value, you must prefix the value with `cio_`. You can [look up a person using the App API](/integrations/api/app/tag/customers/) to find their `cio_id`.\n\nYou must use this value to update a person's other identifiers—their `id` or `email`, unless you enable your workspace's [Allow updates to email using ID](/accounts/workspaces#update-email-with-id) setting.\n", "example": "cio_03000001" } ] } }, "trackEvent_customer_id": { "name": "identifier", "required": true, "in": "path", "description": "The unique value representing a person. You may identify a person by `id`, `email` address, or the `cio_id` (when updating people), depending on your workspace settings. You can't reference a person by their `phone` number here; a phone number in the path is treated as an `id`. To identify people by phone number, use the [Track v2 API](/integrations/api/track/tag/track_v2/).\n", "schema": { "oneOf": [ { "title": "id", "type": "string", "example": 12345, "description": "The unique identifier you assigned to a person." }, { "title": "email", "type": "string", "example": "person@example.com", "description": "A person's email address." }, { "title": "cio_id", "type": "string", "format": "cio_[a-zA-Z0-9]*", "description": "A canonical identifier assigned by Customer.io when you add a person. When referencing a person by this value, you must prefix the value with `cio_`. You can [look up a person using the App API](/integrations/api/app/tag/customers/) to find their `cio_id`, but you must prefix this value with `cio_` when using it to reference a person.\n\nYou can use this value to update a person's other identifiers—their `id` or `email`.\n", "example": "cio_03000001" } ] } }, "customer_id": { "name": "customer_id", "required": true, "in": "path", "description": "The ID of the customer you want to perform an operation against.", "schema": { "type": "string", "example": 12345 } }, "device_id": { "name": "device_id", "in": "path", "required": true, "description": "The ID of the device you want to perform an operation against.", "schema": { "type": "string" } }, "segment_id": { "name": "segment_id", "in": "path", "required": true, "description": "The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find the ID under *Usage*. Or you can find your segment using the [App API](/integrations/api/app/tag/segments/).", "schema": { "type": "integer", "format": "int32" } }, "start": { "name": "start", "in": "query", "required": false, "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results.", "schema": { "type": "string" } }, "resolution": { "name": "res", "in": "query", "description": "Determines increment for metrics—hourly, daily, weekly, or monthly.", "required": true, "schema": { "type": "string", "enum": [ "hours", "hourly", "days", "daily", "weeks", "weekly", "months", "monthly" ] } }, "journey_resolution": { "name": "resolution", "in": "query", "description": "Determines the increment for journey metrics—hourly, daily, weekly, or monthly.", "required": true, "schema": { "type": "string", "enum": [ "hours", "hourly", "days", "daily", "weeks", "weekly", "months", "monthly" ] } }, "limit": { "name": "limit", "in": "query", "required": false, "description": "The maximum number of results you want to retrieve per page.", "schema": { "type": "integer" } }, "limit-10-100": { "name": "limit", "in": "query", "required": false, "description": "The maximum number of results you want to retrieve per page.", "schema": { "type": "integer", "default": 10, "maximum": 100 } }, "limit-50-1000": { "name": "limit", "in": "query", "required": false, "description": "The maximum number of results you want to retrieve per page.", "schema": { "type": "integer", "default": 50, "maximum": 1000 } }, "limit-100-1000": { "name": "limit", "in": "query", "required": false, "description": "The maximum number of results you want to retrieve per page.", "schema": { "type": "integer", "default": 100, "maximum": 1000 } }, "offset": { "name": "offset", "in": "query", "required": false, "description": "The number of records to skip before retrieving results.", "schema": { "type": "integer", "default": 0 } }, "action_id": { "name": "action_id", "in": "path", "required": true, "description": "The action you want to lookup or act on.", "schema": { "type": "integer" } }, "period": { "name": "period", "in": "query", "required": false, "description": "The unit of time for your report.", "schema": { "type": "string", "default": "days", "enum": [ "hours", "days", "weeks", "months" ] } }, "steps": { "name": "steps", "in": "query", "required": false, "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.", "schema": { "type": "integer" } }, "metricType": { "name": "type", "in": "query", "required": false, "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.", "schema": { "type": "string", "enum": [ "email", "webhook", "twilio", "whatsapp", "slack", "push", "in_app", "live_notification" ] } }, "newsletterMetricsType": { "name": "type", "in": "query", "required": false, "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.", "schema": { "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ] } }, "metric": { "name": "metric", "in": "query", "required": false, "description": "Determines the metric(s) you want to return.", "schema": { "type": "string", "enum": [ "attempted", "sent", "delivered", "opened", "clicked", "converted", "bounced", "spammed", "unsubscribed", "dropped", "failed", "undeliverable" ] } }, "unique": { "name": "unique", "in": "query", "required": false, "description": "If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the response contains the total number of results without regard to uniqueness.", "schema": { "type": "boolean", "default": false } }, "drafts": { "name": "drafts", "in": "query", "required": false, "description": "If true, your request returns drafts rather than active/sent messages.", "schema": { "type": "boolean" } }, "get_tracked_responses": { "name": "get_tracked_responses", "in": "query", "required": false, "description": "If true, the response includes `tracked_responses` for each message—an object containing tracked response option names for in-app survey responses.", "schema": { "type": "boolean", "default": false } }, "get_apitb_broadcast_id": { "name": "broadcast_id", "in": "path", "required": true, "description": "The ID of the broadcast that you want to return information about.", "schema": { "type": "integer" } }, "broadcast_id": { "name": "broadcast_id", "in": "path", "required": true, "description": "The identifier of a broadcast.", "schema": { "type": "integer" } }, "state": { "name": "state", "in": "query", "required": false, "description": "The state of a broadcast.", "schema": { "type": "string", "enum": [ "failed", "sent", "drafted", "attempted" ] } }, "start_ts": { "name": "start_ts", "in": "query", "required": false, "description": "The beginning timestamp for your query.", "schema": { "type": "integer", "format": "unix timestamp" } }, "end_ts": { "name": "end_ts", "in": "query", "required": false, "description": "The ending timestamp for your query.", "schema": { "type": "integer", "format": "unix timestamp" } }, "asset-id": { "name": "id", "in": "path", "required": true, "description": "The unique identifier of the resource.", "schema": { "type": "integer", "minimum": 1 } }, "Page": { "name": "page", "in": "query", "description": "The page number of results you want to display. Use with `limit`.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, "Limit": { "name": "limit", "in": "query", "description": "Limit the number of results per page.", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 1000 } }, "AssetParentFolderID": { "name": "parent_folder_id", "in": "query", "description": "Filter results to a specific parent folder. Use 0 or omit to target the root level.", "schema": { "type": "integer" } }, "DirectDescendantsOnly": { "name": "direct_descendants_only", "in": "query", "description": "If true, this returns only children of the parent folder.", "schema": { "type": "boolean", "default": false } }, "folder_id": { "name": "id", "in": "path", "required": true, "description": "The UUID of the folder.", "schema": { "type": "string", "format": "uuid" } }, "email_id": { "name": "id", "in": "path", "required": true, "description": "The UUID of the email. If your email has multiple languages, you must provide the ID of the **default** language template. This links the workflow to all of the language variants for the template.", "schema": { "type": "string", "format": "uuid" } }, "component_id": { "name": "id", "in": "path", "required": true, "description": "The UUID of the component.", "schema": { "type": "string", "format": "uuid" } }, "sms_id": { "name": "id", "in": "path", "required": true, "description": "The UUID of the SMS.", "schema": { "type": "string", "format": "uuid" } }, "inbox_id": { "name": "id", "in": "path", "required": true, "description": "The UUID of the inbox message. If the message has multiple languages, you must provide the ID of the **default** language template. This links the workflow to all of the language variants for the template.", "schema": { "type": "string", "format": "uuid" } }, "Language": { "name": "language", "in": "path", "required": true, "schema": { "type": "string" }, "description": "A [language code](/journeys/channels/localization/attribute/#supported-languages) that indicates the language of your translated email" }, "ParentFolderID": { "name": "parent_folder_id", "in": "query", "schema": { "type": "string", "format": "uuid" }, "description": "Filter by parent folder. Must reference an existing folder. If not set, the response filters by the root level directory.\n\nTo list only items in the root folder, leave `parent_folder_id` unset and only set `direct_descendants_only` to `true`.\n" }, "SortBy": { "name": "sort_by", "in": "query", "schema": { "type": "string", "enum": [ "created", "updated", "name" ], "default": "created" } }, "SortOrder": { "name": "sort_order", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, "CreatedBefore": { "name": "created_before", "in": "query", "schema": { "type": "integer", "format": "Unix timestamp" }, "description": "Return records created before this time. Must be a unix timestamp.", "example": 1773856017 }, "CreatedAfter": { "name": "created_after", "in": "query", "schema": { "type": "integer", "format": "Unix timestamp" }, "description": "Return records created after this time. Must be a unix timestamp.", "example": 1773856017 }, "UpdatedBefore": { "name": "updated_before", "in": "query", "schema": { "type": "integer", "format": "Unix timestamp" }, "description": "Return records updated before this time. Must be a unix timestamp.", "example": 1773856017 }, "UpdatedAfter": { "name": "updated_after", "in": "query", "schema": { "type": "integer", "format": "Unix timestamp" }, "description": "Return records updated after this time. Must be a unix timestamp.", "example": 1773856017 } }, "schemas": { "anyType": { "x-scalar-ignore": true, "description": "Can be any type of value." }, "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" }, "optoutChannels": { "x-scalar-ignore": true, "type": "array", "description": "The senders and channels that the person is opted out of. An entry's presence means the person is opted out of that sender on that channel.", "items": { "type": "object", "properties": { "channel": { "type": "string", "description": "The channel that the person is opted out of.", "enum": [ "sms", "whatsapp" ], "example": "sms" }, "from": { "type": "string", "description": "The sender that the person is opted out of. For SMS, this is a sender phone number (E.164), an alphanumeric sender ID, or a messaging-service SID; for WhatsApp, it's the sender phone number.", "example": "+15551234567" } } } }, "collectionResponse": { "x-scalar-ignore": true, "type": "object", "properties": { "bytes": { "type": "integer", "description": "The size of the collection in bytes.", "example": 296 }, "created_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "id": { "type": "integer", "description": "The identifier for the collection. This is how you'll reference the collection from the API.", "example": 1 }, "name": { "type": "string", "description": "The name of the collection. This is how you'll reference the collection in liquid, e.g. `{{collection_name.data_property}}`.", "example": "upcoming events" }, "rows": { "type": "integer", "description": "Represents the number of objects in the `data` array or CSV rows in your collection schema.", "example": 2 }, "schema": { "type": "array", "description": "Lists the top-level keys that you can reference within this collection. Customer.io does not enforce any of these keys as required from your `data`.", "items": { "type": "string" }, "example": [ "eventDate", "eventName", "presents" ] } } }, "exportSharedProps": { "x-scalar-ignore": true, "description": "Contains properties shared by export filters.", "type": "object", "properties": { "start": { "x-scalar-ignore": true, "description": "The unix timestamp representing the beginning of the export.", "type": "integer", "format": "unix timestamp", "example": 1517529600 }, "end": { "x-scalar-ignore": true, "description": "The unix timestamp representing the end of the export.", "type": "integer", "format": "unix timestamp", "example": 1517702400 }, "attributes": { "description": "Recipient attributes you want to include as extra columns in your export. You can't include event or trigger properties.", "type": "array", "items": { "type": "string" } }, "metric": { "x-scalar-ignore": true, "description": "Determines the metric(s) you want to return.", "type": "string", "enum": [ "created", "attempted", "sent", "delivered", "opened", "clicked", "converted", "bounced", "spammed", "unsubscribed", "dropped", "failed", "undeliverable" ] }, "drafts": { "x-scalar-ignore": true, "description": "If true, your request returns both drafts and active/sent messages.", "type": "boolean" }, "template_id": { "type": "integer", "description": "Restrict the export to a specific message template (content) within the selected automation, newsletter, or transactional message." } } }, "next": { "x-scalar-ignore": true, "type": "string", "description": "Indicates the next page of results. Add `?start=` to the request to get the next page of results." }, "anonymousEventsRequest": { "x-scalar-ignore": true, "description": "An event attributed to an unknown person. If you provide an `anonymous_id` with the event, you can associate the event with a person later (using the anonymous ID).", "oneOf": [ { "title": "Standard anonymous event", "type": "object", "required": [ "name" ], "properties": { "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." }, "name": { "type": "string", "description": "The name of the event. This is how you'll reference the event in automations or segments." }, "id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "type": { "type": "string", "description": "Sets the event type. If your event isn't a `page` or `screen` type event, we automatically set this property to `event`.", "enum": [ "event", "page", "screen" ] }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event took place. If you don't provide this value, we use the date-time when we receive the event.\n" }, "data": { "type": "object", "description": "Additional event data you can reference in Liquid or use to set customer attributes. You can include `from_address` and `reply_to`, but an event only triggers an automation if you associate it with a person within 72 hours.", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in messages or convert to attributes if/when you associate this event with a person." }, "properties": { "from_address": { "x-scalar-ignore": true, "type": "string", "format": "email", "description": "The address you want to trigger messages from, overriding the `from` field in emails triggered by the event." }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "example": "replyto@example.com" } } } }, "example": { "name": "watched_video", "anonymous_id": "abc123", "data": { "video": "intro-to-platform" } } }, { "title": "Page view", "type": "object", "required": [ "name", "type" ], "properties": { "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." }, "name": { "type": "string", "description": "The name of the event. In general, this should be the URL of the page a person visited, making it easy to segment your audience or trigger automations using this event. Make sure you trim leading and trailing spaces from this field." }, "id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "type": { "type": "string", "description": "Indicates that the event represents a page view. See [\"page view\" events](/integrations/data-in/connections/javascript/legacy-js/events/#page-view-events), for more information.", "enum": [ "page" ] }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event took place. If you don't provide this value, we use the date-time when we receive the event.\n" }, "data": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on your customer (referenced by `customer_id`).", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in messages or convert to attributes if/when you associate this event with a person." } } }, "example": { "name": "https://mysite.com/page", "type": "page", "anonymous_id": "abc123", "data": { "first_name": "Person" } } }, { "title": "Mobile screen view", "type": "object", "required": [ "name", "type" ], "properties": { "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." }, "name": { "type": "string", "description": "The screen or deep link path the person viewed, so you can segment your audience or trigger automations from this event. Trim any leading and trailing spaces." }, "id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "type": { "type": "string", "description": "Indicates that the event represents a mobile screen view. You can also capture screen events directly with [our iOS SDK](/integrations/sdk/ios/track-events/#screen-view-events).", "enum": [ "screen" ] }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event took place. If you don't provide this value, we use the date-time when we receive the event.\n" }, "data": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on your customer (referenced by `customer_id`).", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in messages or convert to attributes if/when you associate this event with a person." } } }, "example": { "name": "homepage", "type": "screen", "anonymous_id": "abc123" } } ] }, "dedupe_id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "eventsRequest": { "x-scalar-ignore": true, "oneOf": [ { "title": "Standard event", "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the event. This is how you'll reference the event in automations or segments." }, "id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "type": { "type": "string", "description": "Sets the event type. If your event isn't a `page` or `screen` type event, we automatically set this property to `event`.", "enum": [ "event" ] }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event took place. If you don't provide this value, we use the date-time when we receive the event.\n\n**NOTE**: Events with a timestamp in the past 72 hours can trigger automations.\n" }, "data": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on your customer (referenced by `customer_id`).", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." }, "properties": { "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "from_address": { "x-scalar-ignore": true, "type": "string", "format": "email", "description": "The address you want to trigger messages from, overriding the `from` field in emails triggered by the event." }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "example": "replyto@example.com" } } } }, "example": { "name": "purchase", "data": { "price": 23.45, "product": "socks" } } }, { "title": "Page view", "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string", "description": "The name of the event. This is how you'll reference the event in automations or segments." }, "id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "type": { "type": "string", "description": "Indicates that the event represents a page view. See [\"page view\" events](/integrations/data-in/connections/javascript/legacy-js/events/#page-view-events), for more information.", "enum": [ "page" ] }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event took place. If you don't provide this value, we use the date-time when we receive the event.\n" }, "data": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on your customer (referenced by `customer_id`).", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in messages or convert to attributes if/when you associate this event with a person." } } }, "example": { "name": "https://mysite.com/page", "type": "page", "data": { "first_name": "Cool", "last_name": "Person" } } }, { "title": "Mobile screen view", "type": "object", "required": [ "anonymous_id", "name", "type" ], "properties": { "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." }, "name": { "type": "string", "description": "The screen or deep link path the person viewed, so you can segment your audience or trigger automations from this event. Trim any leading and trailing spaces." }, "id": { "x-scalar-ignore": true, "type": "string", "format": "ulid", "description": "A [ULID](https://github.com/ulid/spec) we use to deduplicate events. If an event repeats a value we've already received, we ignore the duplicate. Our Python and Ruby libraries don't pass this ID." }, "type": { "type": "string", "description": "Indicates that the event represents a mobile screen view. You can also capture screen events directly with [our iOS SDK](/integrations/sdk/ios/track-events/#screen-view-events).", "enum": [ "screen" ] }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event took place. If you don't provide this value, we use the date-time when we receive the event.\n" }, "data": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on your customer (referenced by `customer_id`).", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in messages or convert to attributes if/when you associate this event with a person." } } }, "example": { "name": "homepage", "type": "screen", "data": { "from": "push-notification" } } } ] }, "activityObject": { "x-scalar-ignore": true, "type": "object", "properties": { "customer_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" }, "customer_identifiers": { "x-scalar-ignore": true, "type": "object", "description": "Identifiers for the person in a response—`id`, `cio_id`, and `email`. Unset `id` or `email` values are `null`. We recommend this object over the less descriptive `customer_id`. This object doesn't include `phone`, even if your workspace uses phone numbers as an identifier; look for the person's `phone` attribute instead.", "required": [ "email", "id", "cio_id" ], "properties": { "email": { "type": [ "string", "null" ], "format": "email", "description": "A person's email address, if set.", "example": "test@example.com" }, "id": { "type": [ "string", "null" ], "description": "A person's unique ID, if set. This is the same as the `customer_id` if present.", "example": 2 }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } }, "data": { "oneOf": [ { "title": "Message delivery", "type": "object", "properties": { "delivered": { "type": [ "integer", "null" ], "format": "unix timestamp", "description": "The date-time when the message was delivered, if applicable." }, "delivery_id": { "type": "string", "description": "The message ID." }, "opened": { "type": [ "boolean", "null" ], "description": "Indicates whether or not a customer opened a message, if the message was delivered." } }, "example": { "delivery_id": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==", "opened": null, "delivered": null } }, { "title": "Attribute change", "description": "The name of the object is the attribute that changed.", "type": "object", "additionalProperties": { "x-scalar-ignore": true, "type": "object", "properties": { "from": { "type": "string", "description": "The old attribute value. If empty, the customer probably didn't bear the attribute before this action." }, "to": { "type": "string", "description": "The new attribute value." } } }, "example": { "email": { "from": "newPerson@example.com", "to": "newPerson@customer.io" } } } ] }, "delivery_id": { "type": "string", "description": "The message ID.", "example": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==" }, "delivery_type": { "type": "string", "description": "The recipient device, if applicable.", "enum": [ "ios", "android", "email", "phone" ], "example": "email" }, "id": { "description": "The identifier for the action.", "type": "string", "example": "01AK4N8V8G8KVA4HN8Y50CCZ59" }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The date and time when the action occurred.", "example": 1397566226 }, "type": { "x-scalar-ignore": true, "description": "The type of activity. Types with `_o:` are for objects and types with `_r:` are for relationships.", "type": "string", "enum": [ "add_relationship", "anon_merge", "attempted_action", "attempted_email", "attempted_in_app", "attempted_push", "attempted_slack", "attempted_twilio", "attempted_webhook", "attempted_whatsapp", "attribute_change", "bounced_action", "bounced_email", "bounced_push", "bounced_twilio", "bounced_whatsapp", "clicked_action", "clicked_content", "clicked_email", "clicked_in_app", "clicked_push", "clicked_twilio", "clicked_webhook", "converted_action", "converted_content", "converted_email", "converted_in_app", "converted_slack", "converted_twilio", "converted_webhook", "converted_whatsapp", "deferred_action", "deferred_email", "deferred_in_app", "deferred_push", "deferred_slack", "deferred_twilio", "deferred_webhook", "deferred_whatsapp", "delete_relationship", "delivered_action", "delivered_email", "delivered_push", "delivered_twilio", "delivered_whatsapp", "device_change", "drafted_action", "drafted_email", "drafted_in_app", "drafted_push", "drafted_slack", "drafted_twilio", "drafted_webhook", "dropped_action", "dropped_email", "dropped_push", "dropped_twilio", "dropped_webhook", "dropped_whatasapp", "event", "failed_action", "failed_attribute_change", "failed_batch_update", "failed_email", "failed_event", "failed_in_app", "failed_object_journeys", "failed_push", "failed_query_collection", "failed_slack", "failed_twilio", "failed_webhook", "failed_whatsapp", "opened_action", "opened_email", "opened_in_app", "opened_push", "page", "profile_create", "profile_delete", "profile_merge", "relationship_attribute_change", "relationship_failed_attribute_change", "screen", "sent_action", "sent_email", "sent_in_app", "sent_push", "sent_slack", "sent_twilio", "sent_webhook", "sent_whatsapp", "skipped_update", "spammed_email", "suppressed_twilio", "suppressed_whatsapp", "topic_unsubscribed_email", "undeliverable_action", "undeliverable_email", "undeliverable_in_app", "undeliverable_push", "undeliverable_slack", "undeliverable_twilio", "undeliverable_webhook", "undeliverable_whatsapp", "unsubscribed_action", "unsubscribed_email", "viewed_content", "webhook_event", "_o::add_relationship", "_o::attribute_change", "_o::create", "_o::delete", "_o::delete_relationship", "_o::failed_attribute_change", "_r::attribute_change", "_r::failed_attribute_change" ], "example": "sent_email" }, "name": { "type": "string", "description": "The name of the event, for `event` and `screen` activities." }, "url": { "type": "string", "description": "The page URL, for `page` activities." } } }, "delivery_id": { "x-scalar-ignore": true, "type": "string", "description": "The instance of a message sent to a person.", "example": "ZAIAAVTJVG0QcCok0-0ZKj6yiQ==" }, "activityTypes": { "x-scalar-ignore": true, "description": "The type of activity. Types with `_o:` are for objects and types with `_r:` are for relationships.", "type": "string", "enum": [ "add_relationship", "anon_merge", "attempted_action", "attempted_email", "attempted_in_app", "attempted_push", "attempted_slack", "attempted_twilio", "attempted_webhook", "attempted_whatsapp", "attribute_change", "bounced_action", "bounced_email", "bounced_push", "bounced_twilio", "bounced_whatsapp", "clicked_action", "clicked_content", "clicked_email", "clicked_in_app", "clicked_push", "clicked_twilio", "clicked_webhook", "converted_action", "converted_content", "converted_email", "converted_in_app", "converted_slack", "converted_twilio", "converted_webhook", "converted_whatsapp", "deferred_action", "deferred_email", "deferred_in_app", "deferred_push", "deferred_slack", "deferred_twilio", "deferred_webhook", "deferred_whatsapp", "delete_relationship", "delivered_action", "delivered_email", "delivered_push", "delivered_twilio", "delivered_whatsapp", "device_change", "drafted_action", "drafted_email", "drafted_in_app", "drafted_push", "drafted_slack", "drafted_twilio", "drafted_webhook", "dropped_action", "dropped_email", "dropped_push", "dropped_twilio", "dropped_webhook", "dropped_whatasapp", "event", "failed_action", "failed_attribute_change", "failed_batch_update", "failed_email", "failed_event", "failed_in_app", "failed_object_journeys", "failed_push", "failed_query_collection", "failed_slack", "failed_twilio", "failed_webhook", "failed_whatsapp", "opened_action", "opened_email", "opened_in_app", "opened_push", "page", "profile_create", "profile_delete", "profile_merge", "relationship_attribute_change", "relationship_failed_attribute_change", "screen", "sent_action", "sent_email", "sent_in_app", "sent_push", "sent_slack", "sent_twilio", "sent_webhook", "sent_whatsapp", "skipped_update", "spammed_email", "suppressed_twilio", "suppressed_whatsapp", "topic_unsubscribed_email", "undeliverable_action", "undeliverable_email", "undeliverable_in_app", "undeliverable_push", "undeliverable_slack", "undeliverable_twilio", "undeliverable_webhook", "undeliverable_whatsapp", "unsubscribed_action", "unsubscribed_email", "viewed_content", "webhook_event", "_o::add_relationship", "_o::attribute_change", "_o::create", "_o::delete", "_o::delete_relationship", "_o::failed_attribute_change", "_r::attribute_change", "_r::failed_attribute_change" ], "example": "sent_email" }, "attributeChangeAction": { "x-scalar-ignore": true, "type": "object", "properties": { "from": { "type": "string", "description": "The old attribute value. If empty, the customer probably didn't bear the attribute before this action." }, "to": { "type": "string", "description": "The new attribute value." } } }, "segmentAudienceFilter": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attributeAudienceFilter": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } }, "simpleAudienceFilter": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "complexAudienceFilter": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } }, "andAudienceFilter": { "x-scalar-ignore": true, "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "type": "object", "properties": { "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, "orAudienceFilter": { "x-scalar-ignore": true, "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "type": "object", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, "notAudienceFilter": { "x-scalar-ignore": true, "title": "not", "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "audienceFilter": { "x-scalar-ignore": true, "title": "Audience Filter", "description": "Use `and`, `or`, and `not` to combine segment and attribute conditions. The top-level object accepts one property; nest groups for complex filters.", "oneOf": [ { "x-scalar-ignore": true, "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "type": "object", "properties": { "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "x-scalar-ignore": true, "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "type": "object", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "x-scalar-ignore": true, "title": "not", "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "objectattributeFilter": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } }, "objectFilterAnd": { "x-scalar-ignore": true, "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "type": "object", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } } } }, "objectFilterOr": { "x-scalar-ignore": true, "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "type": "object", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } } } }, "objectFilterNot": { "x-scalar-ignore": true, "title": "not", "type": "object", "properties": { "not": { "type": "object", "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single condition.", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } } }, "objectFilter": { "x-scalar-ignore": true, "title": "Object Filter", "description": "Use `and`, `or`, and `not` to combine object attribute conditions. The top-level object accepts one property; nest groups for complex filters.", "oneOf": [ { "x-scalar-ignore": true, "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "type": "object", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } } } }, { "x-scalar-ignore": true, "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "type": "object", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } } } }, { "x-scalar-ignore": true, "title": "not", "type": "object", "properties": { "not": { "type": "object", "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single condition.", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } } }, { "title": "object attribute", "type": "object", "description": "A simple filter to find objects matching an attribute condition.", "properties": { "object_attribute": { "x-scalar-ignore": true, "title": "object attribute", "description": "Filter your objects by their attributes.", "type": "object", "required": [ "field", "operator", "type_id" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "location" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if an object has the attribute; `eq` returns results an object's attribute exists and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." }, "type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" } }, "example": { "field": "cancelled", "operator": "eq", "value": true, "type_id": 1 } } } } ] }, "device_object_common": { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } }, "device_object_cdp_common": { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] }, "network_bluetooth": { "type": "boolean", "description": "If `true`, the device's bluetooth connection is on." }, "network_cellular": { "type": "boolean", "description": "If `true`, the device's cellular connection is on." }, "network_wifi": { "type": "boolean", "description": "If `true`, the device's WiFi connection is on." }, "screen_height": { "type": "integer", "description": "The height of the device's screen in pixels." }, "screen_width": { "type": "integer", "description": "The width of the device's screen in pixels." }, "timezone": { "type": "string", "description": "The time zone of the device." } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } }, "device_object": { "x-scalar-ignore": true, "description": "Device properties collected by [Customer.io SDKs](/integrations/sdk/) unless `autoTrackDeviceAttributes` is disabled. You can use these properties in segments and Liquid.", "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] }, "device_object_cdp": { "x-scalar-ignore": true, "description": "Device properties for Journeys profiles sent from a [Data Pipelines-enabled SDK](/integrations/sdk/). SDKs collect these automatically unless `autoTrackDeviceAttributes` is disabled.", "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] }, "network_bluetooth": { "type": "boolean", "description": "If `true`, the device's bluetooth connection is on." }, "network_cellular": { "type": "boolean", "description": "If `true`, the device's cellular connection is on." }, "network_wifi": { "type": "boolean", "description": "If `true`, the device's WiFi connection is on." }, "screen_height": { "type": "integer", "description": "The height of the device's screen in pixels." }, "screen_width": { "type": "integer", "description": "The width of the device's screen in pixels." }, "timezone": { "type": "string", "description": "The time zone of the device." } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] }, "import_request": { "x-scalar-ignore": true, "oneOf": [ { "title": "people", "type": "object", "description": "Contains your import parameters.", "required": [ "data_file_url", "name", "type", "identifier" ], "properties": { "name": { "x-scalar-ignore": true, "type": "string", "description": "A friendly name for your import. This helps you identify your import." }, "data_file_url": { "type": "string", "description": "The URL or path to the CSV file you want to import." }, "type": { "type": "string", "description": "The type of import.", "enum": [ "people" ] }, "identifier": { "x-scalar-ignore": true, "type": "string", "description": "The type of identifier you want to use to identify people in your sheet—`id` or `email`. At least one column in the CSV must contain an identifier.", "enum": [ "id", "email" ] }, "data_to_process": { "x-scalar-ignore": true, "type": "string", "description": "Controls whether your import adds and updates all rows, adds only new rows, or updates only existing rows. Defaults to `all`. Event imports support only `all` and `only_existing`. Formerly called `people_to_process`.", "enum": [ "all", "only_new", "only_existing" ] }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A helpful description that can help you find and recognize your import operation." } } }, { "title": "event", "type": "object", "description": "Contains your import parameters.", "required": [ "data_file_url", "name", "type", "identifier" ], "properties": { "name": { "x-scalar-ignore": true, "type": "string", "description": "A friendly name for your import. This helps you identify your import." }, "data_file_url": { "type": "string", "description": "The URL or path to the CSV file you want to import." }, "type": { "type": "string", "description": "The type of import.", "enum": [ "event" ] }, "identifier": { "x-scalar-ignore": true, "type": "string", "description": "The type of identifier you want to use to identify people in your sheet—`id` or `email`. At least one column in the CSV must contain an identifier.", "enum": [ "id", "email" ] }, "data_to_process": { "x-scalar-ignore": true, "type": "string", "description": "Controls whether your import adds and updates all rows, adds only new rows, or updates only existing rows. Defaults to `all`. Event imports support only `all` and `only_existing`. Formerly called `people_to_process`.", "enum": [ "all", "only_new", "only_existing" ] }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A helpful description that can help you find and recognize your import operation." } } }, { "title": "relationship", "type": "object", "description": "Contains your import parameters.", "required": [ "data_file_url", "name", "type", "identifier" ], "properties": { "name": { "x-scalar-ignore": true, "type": "string", "description": "A friendly name for your import. This helps you identify your import." }, "data_file_url": { "type": "string", "description": "The URL or path to the CSV file you want to import." }, "type": { "type": "string", "description": "The type of import.", "enum": [ "relationship" ] }, "identifier": { "type": "string", "description": "The type of identifier used to identify the person in each relationship—`id`, `email`, or `cio_id`.", "enum": [ "id", "email", "cio_id" ] }, "data_to_process": { "x-scalar-ignore": true, "type": "string", "description": "Controls whether your import adds and updates all rows, adds only new rows, or updates only existing rows. Defaults to `all`. Event imports support only `all` and `only_existing`. Formerly called `people_to_process`.", "enum": [ "all", "only_new", "only_existing" ] }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A helpful description that can help you find and recognize your import operation." } } }, { "title": "object", "type": "object", "description": "Contains your import parameters.", "required": [ "data_file_url", "name", "type", "object_type_id" ], "properties": { "name": { "x-scalar-ignore": true, "type": "string", "description": "A friendly name for your import. This helps you identify your import." }, "data_file_url": { "type": "string", "description": "The URL or path to the CSV file you want to import." }, "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "type": { "type": "string", "description": "The type of import.", "enum": [ "object" ] }, "data_to_process": { "x-scalar-ignore": true, "type": "string", "description": "Controls whether your import adds and updates all rows, adds only new rows, or updates only existing rows. Defaults to `all`. Event imports support only `all` and `only_existing`. Formerly called `people_to_process`.", "enum": [ "all", "only_new", "only_existing" ] }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A helpful description that can help you find and recognize your import operation." } } } ] }, "import_name": { "x-scalar-ignore": true, "type": "string", "description": "A friendly name for your import. This helps you identify your import." }, "import_type": { "x-scalar-ignore": true, "type": "string", "description": "The type of import.", "enum": [ "people", "event", "object", "relationship" ] }, "import_description": { "x-scalar-ignore": true, "type": "string", "description": "A helpful description that can help you find and recognize your import operation." }, "import_state": { "x-scalar-ignore": true, "type": "string", "description": "The state of the import—whether your import is being processed, fully completed (`imported`), or if it failed.", "enum": [ "preprocessing", "preprocessed", "validating", "validated", "importing", "imported", "failed", "canceled" ] }, "rows_to_import": { "x-scalar-ignore": true, "type": "integer", "description": "The total number of importable rows we found in the CSV." }, "rows_imported": { "x-scalar-ignore": true, "type": "integer", "description": "The number of rows we imported from the CSV." }, "data_to_process": { "x-scalar-ignore": true, "type": "string", "description": "Controls whether your import adds and updates all rows, adds only new rows, or updates only existing rows. Defaults to `all`. Event imports support only `all` and `only_existing`. Formerly called `people_to_process`.", "enum": [ "all", "only_new", "only_existing" ] }, "import_identifier": { "x-scalar-ignore": true, "type": "string", "description": "The type of identifier you want to use to identify people in your sheet—`id` or `email`. At least one column in the CSV must contain an identifier.", "enum": [ "id", "email" ] }, "import_object": { "x-scalar-ignore": true, "description": "Represents an import operation.", "type": "object", "properties": { "id": { "type": "integer", "description": "This is the `import_id` you'll use if you want to [lookup your import operation](/integrations/api/app/tag/imports/getImport/)." }, "created_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "name": { "x-scalar-ignore": true, "type": "string", "description": "A friendly name for your import. This helps you identify your import." }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A helpful description that can help you find and recognize your import operation." }, "rows_to_import": { "x-scalar-ignore": true, "type": "integer", "description": "The total number of importable rows we found in the CSV." }, "rows_imported": { "x-scalar-ignore": true, "type": "integer", "description": "The number of rows we imported from the CSV." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The state of the import—whether your import is being processed, fully completed (`imported`), or if it failed.", "enum": [ "preprocessing", "preprocessed", "validating", "validated", "importing", "imported", "failed", "canceled" ] }, "type": { "x-scalar-ignore": true, "type": "string", "description": "The type of import.", "enum": [ "people", "event", "object", "relationship" ] }, "identifier": { "type": "string", "description": "The type of identifier you used to identify people in your CSV. Not applicable for object imports.", "enum": [ "id", "email" ] }, "data_to_process": { "x-scalar-ignore": true, "type": "string", "description": "Controls whether your import adds and updates all rows, adds only new rows, or updates only existing rows. Defaults to `all`. Event imports support only `all` and `only_existing`. Formerly called `people_to_process`.", "enum": [ "all", "only_new", "only_existing" ] }, "people_to_process": { "type": "string", "description": "Returned for people and event imports, even if you imported using the field `data_to_process`. This field will be deprecated soon.\n", "enum": [ "all", "only_new", "only_existing" ] }, "object_type_id": { "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Only applies to object imports.", "example": "1" }, "error": { "description": "If your import fails, this helps you understand why.", "type": "string" } }, "example": { "id": 30, "name": "account-object-import", "description": "importing accounts", "created_at": 1706081641, "updated_at": 1706081645, "rows_to_import": 3, "rows_imported": 3, "state": "imported", "type": "object", "data_to_process": "all", "people_to_process": "all", "object_type_id": 1, "error": "possible error - The specified Object Type does not exist." } }, "customerAttributesObject": { "x-scalar-ignore": true, "type": "object", "properties": { "customer": { "type": "object", "description": "The profile you referenced by ID in the request.", "properties": { "id": { "type": "string", "description": "The customer ID referenced in the request." }, "identifiers": { "x-scalar-ignore": true, "type": "object", "description": "Identifiers for the person in a response—`id`, `cio_id`, and `email`. Unset `id` or `email` values are `null`. We recommend this object over the less descriptive `customer_id`. This object doesn't include `phone`, even if your workspace uses phone numbers as an identifier; look for the person's `phone` attribute instead.", "required": [ "email", "id", "cio_id" ], "properties": { "email": { "type": [ "string", "null" ], "format": "email", "description": "A person's email address, if set.", "example": "test@example.com" }, "id": { "type": [ "string", "null" ], "description": "A person's unique ID, if set. This is the same as the `customer_id` if present.", "example": 2 }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } }, "attributes": { "type": "object", "description": "Contains attributes assigned to this profile, including your workspace's people-identifiers (by default, these are `id`, `email`, and `cio_id`). Attributes are all stored as strings.", "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": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" }, "cio_subscription_preferences": { "type": "string", "description": "A person's subscription preferences as stringified JSON. If unset, preferences are computed from topic defaults; see `_cio_subscription_preferences_computed`." }, "_cio_subscription_preferences_computed": { "type": "string", "description": "A person's computed subscription preferences as stringified JSON, combining set preferences with defaults for unset topics. [Learn more about backfilled preferences](/messaging/channels/subscriptions/center/#backfill-preferences)." } }, "additionalProperties": { "x-additionalPropertiesName": "additional attributes", "description": "Non-identifier attributes assigned to this person.", "type": "string" } }, "timestamps": { "deprecated": true, "type": "object", "description": "The epoch timestamps when corresponding attributes were set on the customer profile.", "properties": { "cio_id": { "type": "integer", "description": "The date-time when `cio_id` was assigned.", "format": "unix timestamp" }, "_last_emailed": { "type": "integer", "description": "The date-time when you last emailed a person.", "format": "unix timestamp" }, "email": { "type": "integer", "description": "The date-time when the person's email address was added.", "format": "unix timestamp" }, "id": { "type": "integer", "description": "The date-time when the person's ID was generated.", "format": "unix timestamp" }, "unsubscribed": { "type": "integer", "description": "The date-time when the person unsubscribed.", "format": "unix timestamp" }, "_cio_subscription_preferences_computed": { "type": "integer", "description": "Because this value is computed and not actually set on a person, this value is always 0" }, "cio_subscription_preferences": { "type": "integer", "description": "The datetime when a person's subscription preferences were last updated.", "format": "unix timestamp" }, "additionalProperties": { "x-additionalPropertiesName": "additional attribute timestamps", "description": "Timestamps when attributes assigned to the person were set.", "format": "unix timestamp" } } }, "unsubscribed": { "type": "boolean", "description": "If `true`, a person is globally unsubscribed from email, SMS, WhatsApp, and push. Values like `true`, `TRUE`, `1`, and `\"1\"` count as true; other values are treated as subscribed or topic-based." }, "devices": { "type": "array", "description": "Lists the devices associated with the customer profile.", "items": { "x-scalar-ignore": true, "description": "Device properties collected by [Customer.io SDKs](/integrations/sdk/) unless `autoTrackDeviceAttributes` is disabled. You can use these properties in segments and Liquid.", "allOf": [ { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] } } } } }, "example": { "customer": { "id": "1", "attributes": { "_last_emailed": "1528932553", "created_at": "1489014595", "email": "test@example.com", "title": "tester", "department": "qa", "id": "1", "cio_id": "03000001", "cio_subscription_preferences": "{\"topics\":{\"topic_7\":false,\"topic_8\":false}}", "_cio_subscription_preferences_computed": "{\"topics\":{\"topic_6\":false,\"topic_7\":false,\"topic_8\":false}}" }, "timestamps": { "cio_id": 1489014595, "_last_emailed": 1528932553, "created_at": 1489014595, "email": 1508932553, "id": 1489014595, "department": 1508932553, "title": 1508932553, "_cio_subscription_preferences_computed": 0, "cio_subscription_preferences": 1673987303 }, "unsubscribed": false, "devices": [ { "id": "my_android_device_id", "last_used": 1514764800, "platform": "android" }, { "id": "my_ios_device_id", "last_used": 1514764800, "platform": "ios" } ] } } }, "preheader": { "x-scalar-ignore": true, "type": "string", "description": "Also known as \"preview text\", this is the block block of text that users see next to, or underneath, the subject line in their inbox." }, "body_plain": { "x-scalar-ignore": true, "type": "string", "description": "By default, your workspace generates a plaintext version of your message body for each delivery. Use this key to override the default plain text body." }, "attachments": { "x-scalar-ignore": true, "type": "object", "description": "A dictionary of attachments where the filename is the key and the value is the base64-encoded contents. The filename must include the extension (i.e. `name.csv`). The total size of all attachments must be less than 2 MB.", "properties": { "": { "type": "string", "format": "base64" } } }, "update_headers": { "x-scalar-ignore": true, "description": "Headers you want to add or update. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "value": { "type": "string", "description": "The value of the header." } }, "example": [ { "name": "X-Mailgun-Tag", "value": "my-cool-tag" } ] } }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "disable_message_retention": { "x-scalar-ignore": true, "type": "boolean", "default": false, "description": "If true, the message body is not retained in delivery history. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "send_to_unsubscribed": { "x-scalar-ignore": true, "type": "boolean", "default": true, "description": "If false, your message is not sent to unsubscribed recipients. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "tracked": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, Customer.io tracks opens and link clicks in your message.", "default": true }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false }, "customer_identifiers": { "x-scalar-ignore": true, "type": "object", "description": "Identifiers for the person in a response—`id`, `cio_id`, and `email`. Unset `id` or `email` values are `null`. We recommend this object over the less descriptive `customer_id`. This object doesn't include `phone`, even if your workspace uses phone numbers as an identifier; look for the person's `phone` attribute instead.", "required": [ "email", "id", "cio_id" ], "properties": { "email": { "type": [ "string", "null" ], "format": "email", "description": "A person's email address, if set.", "example": "test@example.com" }, "id": { "type": [ "string", "null" ], "description": "A person's unique ID, if set. This is the same as the `customer_id` if present.", "example": 2 }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } }, "transactionalSharedEmailObject": { "x-scalar-ignore": true, "type": "object", "properties": { "to": { "type": "string", "description": "The recipients you want to send to, separated by commas. You can include up to 15 total recipients across `to`, `cc`, and `bcc`, with optional display names in quotes.", "example": "cool.person@example.com" }, "cc": { "type": "string", "description": "Carbon copy message recipients, separated by commas. Unlike BCC recipients, CC recipients are visible to everyone who receives the message. Their opens, clicks, and bounces count toward your message metrics. CC recipients count toward the limit of 15 total recipients across the `to`, `cc`, and `bcc` keys.", "example": "cc@example.com" }, "bcc": { "type": "string", "description": "Blind copy message recipients. Supports multiple addresses separated by commas. Your request can contain up to 15 total recipients between the `to`, `cc`, and `bcc` keys.", "example": "bcc@example.com" }, "fake_bcc": { "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "reply_to": { "type": "string", "description": "The address that recipients can reply to, if different from the `from` address.", "example": "replyto@example.com" }, "preheader": { "x-scalar-ignore": true, "type": "string", "description": "Also known as \"preview text\", this is the block block of text that users see next to, or underneath, the subject line in their inbox." }, "attachments": { "x-scalar-ignore": true, "type": "object", "description": "A dictionary of attachments where the filename is the key and the value is the base64-encoded contents. The filename must include the extension (i.e. `name.csv`). The total size of all attachments must be less than 2 MB.", "properties": { "": { "type": "string", "format": "base64" } } }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "disable_css_preprocessing": { "type": "boolean", "description": "Set to `true` to disable CSS preprocessing. This setting overrides the CSS preprocessing setting on the `transactional_message_id` as set in the user interface. Transactional emails have CSS preprocessing enabled by default.", "example": false, "default": false }, "tracked": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, Customer.io tracks opens and link clicks in your message.", "default": true } } }, "transactionalSharedPushObject": { "x-scalar-ignore": true, "type": "object", "properties": { "to": { "type": "string", "description": "The devices you want to send this push to—`all`, `last_used`, or a custom device token from the identified profile. Defaults to `all` and overrides the `To` value from your transactional template.", "enum": [ "all", "last_used", "$device_token" ], "default": "all" }, "title": { "type": "string", "description": "The title for your notification. This overrides the title of the transactional template (referenced by `transactional_message_id`)." }, "message": { "type": "string", "description": "The message body for your notification. This overrides the notification body of the transactional template (referenced by `transactional_message_id`)." }, "image_url": { "type": "string", "description": "An image URL to show in the push. This overrides Image from the transactional template (referenced by `transactional_message_id`)." }, "link": { "type": "string", "description": "A deep link to open when the push is tapped. This overrides Link from the transactional template (referenced by `transactional_message_id`)." }, "sound": { "type": "string", "description": "**For iOS Only**: your notification can alert users with the device's default notification sound or play no sound at all.\n", "enum": [ "default", "none" ], "default": "default" }, "custom_data": { "type": "object", "description": "Optional key/value pairs you want to attach to the push payload. Firebase only supports string values. This overrides the Custom Data from your transactional template." }, "custom_device": { "description": "A device to perform an upsert operation at the time of send. The device will be added/updated on the profile from the Identifiers block.", "allOf": [ { "type": "object", "required": [ "token" ], "properties": { "token": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] }, "custom_payload": { "type": "object", "description": "Optional key/value pairs you want to attach to the push payload. Firebase only supports string values. This overrides all other payload values, including the Custom Payload from your transactional template.", "properties": { "ios": { "x-scalar-ignore": true, "description": "Your payload changes depending on whether you send to iOS devices through Google's Firebase Cloud Messaging (FCM) or Apple's Push Notification service (APNs).", "oneOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The base object for all FCM payloads.", "required": [ "apns" ], "properties": { "apns": { "type": "object", "required": [ "payload" ], "description": "Defines a payload for iOS devices sent through Firebase Cloud Messaging (FCM).", "properties": { "headers": { "description": "Headers defined by [Apple's payload reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) that you want to pass through FCM.", "type": "object" }, "payload": { "type": "object", "description": "Contains a push payload.", "properties": { "CIO": { "type": "object", "description": "Contains properties interpreted by the Customer.io iOS SDK.", "required": [ "push" ], "properties": { "push": { "type": "object", "description": "A push payload for the iOS SDK.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } }, "additionalProperties": { "description": "Additional properties that you've set up your app to interpret outside of the Customer.io SDK.", "x-additionalPropertiesName": "Custom key-value pairs" } } } } } } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "CIO": { "type": "object", "required": [ "push" ], "description": "Contains options supported by the Customer.io SDK.", "properties": { "push": { "type": "object", "description": "Describes push notification options supported by the CIO SDK.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } } } ] }, "android": { "x-scalar-ignore": true, "type": "object", "description": "A custom push payload for Android devices.", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The parent object for Android custom push payloads.", "properties": { "notification": { "type": "object", "description": "Contains the push body and title.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." } } }, "data": { "type": "object", "description": "Contains key-value pairs that your app interprets.", "additionalProperties": { "x-additionalPropertiesName": "Attachment Names", "x-doNotRender": true, "type": "string" } }, "android": { "type": "object", "description": "Contains custom push options for your notification.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } } } } } }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/journeys/channels/localization/getting-started/#supported-languages)." } } }, "transactionalSharedObject": { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": 12345 } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "cool.person@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in your message.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" } }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "disable_message_retention": { "x-scalar-ignore": true, "type": "boolean", "default": false, "description": "If true, the message body is not retained in delivery history. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "send_to_unsubscribed": { "x-scalar-ignore": true, "type": "boolean", "default": true, "description": "If false, your message is not sent to unsubscribed recipients. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false } } }, "snippetRequest": { "x-scalar-ignore": true, "type": "object", "description": "Request body for creating or updating a snippet. Only `name` and `value` are accepted; `updated_at` is returned in responses only.", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "maxLength": 150, "description": "The name of the snippet, must be unique. Trimmed of leading and trailing whitespace before storage." }, "value": { "type": "string", "description": "The contents of the snippet (plain text or Liquid). Trimmed of leading and trailing whitespace before storage. Max length is environment-specific (default 16000)." } }, "example": { "name": "address", "value": "My Company
1234 Fake St
Fake,NY
10111" } }, "snippet": { "x-scalar-ignore": true, "type": "object", "description": "describes a piece of reusable content. You must provide a name for the snippet and the `value`—the content that appears in messages that use the snippet.", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the snippet, must be unique." }, "value": { "type": "string", "description": "The contents of the snippet." }, "updated_at": { "type": "integer", "format": "unix timestamp", "description": "The last date-time the snippet was updated.", "readOnly": true } }, "example": { "name": "address", "value": "My Company
1234 Fake St
Fake,NY
10111", "updated_at": 1582500000 } }, "senderIdentityObject": { "x-scalar-ignore": true, "type": "object", "description": "Information about a sender.", "properties": { "id": { "type": "integer", "description": "The identifier of a sender." }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the sender." }, "email": { "type": "string", "description": "The email address of the sender." }, "address": { "type": "string", "description": "The sender name and email address in the format `name `." }, "template_type": { "type": "string", "enum": [ "email", "phone" ], "description": "The type of sender." }, "auto_generated": { "type": "boolean", "description": "If true, the sender is automatically generated by Customer.io." }, "phone": { "type": "string", "description": "The phone number of the sender, used for SMS senders." }, "hidden": { "type": "boolean", "description": "If true, the sender is hidden in the Customer.io UI." } }, "example": { "id": 4534, "deduplicate_id": "4534:1478035647", "name": "Cher Ami", "email": "test@example.com", "address": "Cher Ami ", "template_type": "email", "auto_generated": false } }, "export_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for the export.", "example": 110 }, "export_type": { "x-scalar-ignore": true, "type": "string", "description": "The type of information contained in the export.", "enum": [ "customers", "deliveries" ], "example": "customers" }, "export_failed": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the export was unsuccessful.", "example": false }, "export_description": { "x-scalar-ignore": true, "type": "string", "description": "A description of the export.", "example": "Customers with segment filters—in Purchased Flowers" }, "export_downloads": { "x-scalar-ignore": true, "type": "integer", "description": "Counts the total number of times the export has been downloaded.", "example": 2 }, "metric": { "x-scalar-ignore": true, "description": "Determines the metric(s) you want to return.", "type": "string", "enum": [ "created", "attempted", "sent", "delivered", "opened", "clicked", "converted", "bounced", "spammed", "unsubscribed", "dropped", "failed", "undeliverable" ] }, "start": { "x-scalar-ignore": true, "description": "The unix timestamp representing the beginning of the export.", "type": "integer", "format": "unix timestamp", "example": 1517529600 }, "end": { "x-scalar-ignore": true, "description": "The unix timestamp representing the end of the export.", "type": "integer", "format": "unix timestamp", "example": 1517702400 }, "drafts": { "x-scalar-ignore": true, "description": "If true, your request returns both drafts and active/sent messages.", "type": "boolean" }, "exportObject": { "x-scalar-ignore": true, "type": "object", "description": "Metadata about an export.", "properties": { "id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for the export.", "example": 110 }, "user_id": { "type": "integer", "description": "The user who created the export." }, "user_email": { "type": "string", "description": "The email of the user who created the export." }, "total": { "type": "integer", "description": "The number of entries in the export. Exports report 0 until done." }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "type": { "x-scalar-ignore": true, "type": "string", "description": "The type of information contained in the export.", "enum": [ "customers", "deliveries" ], "example": "customers" }, "failed": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the export was unsuccessful.", "example": false }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A description of the export.", "example": "Customers with segment filters—in Purchased Flowers" }, "downloads": { "x-scalar-ignore": true, "type": "integer", "description": "Counts the total number of times the export has been downloaded.", "example": 2 }, "created_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "status": { "type": "string", "enum": [ "done", "pending", "failed" ], "description": "The state of your export where `done` indicates an export that you can download, `pending`, indicates that your export is not ready to download, and `failed` indicates an export that has failed and will not be downloadable." } }, "example": { "id": 110, "user_id": 0, "user_email": "person@email.com", "total": 1234, "deduplicate_id": "110:1530296738", "type": "customers", "failed": false, "status": "done", "description": "Customers with segment filters—in \\Purchased Flowers\\", "downloads": 2, "created_at": 1530296738, "updated_at": 1530296738 } }, "variant_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of a newsletter variant—a language in a multi-language newsletter or a test in an A/B test.", "readOnly": true }, "subscription_topic_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of a subscription topic. Remember, subscription topics are assigned an incrementing number, starting at 1.", "example": 1 }, "newsletterErrorResponse": { "x-scalar-ignore": true, "type": "object", "description": "Error response format for newsletter endpoints.", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "detail": { "type": "string", "description": "A message describing the error." } } } } }, "example": { "errors": [ { "detail": "subscription_topic_id is required" } ] } }, "createNewsletterRequest": { "oneOf": [ { "title": "Email", "description": "When you create an email, include `subject` and `body`. Set either `from` or `from_id`, but not both. If you set neither, Customer.io uses your oldest verified sending address.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "subject", "body" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "email" ] }, "subject": { "type": "string", "description": "The subject line of the email." }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body": { "type": "string", "description": "The HTML body content of the email. Use standard HTML/CSS, not syntax unique to Design Studio." }, "body_plain": { "type": "string", "description": "The plaintext body of the email. If provided, this overwrites the auto-generated plaintext." }, "layout_id": { "type": "integer", "description": "The ID of the [layout](/journeys/channels/email/layouts/3-layouts-and-customerio/) you want to use for the email. If you don't set one, the email uses your workspace's default layout. Find a layout's ID in its URL." }, "from": { "type": "string", "description": "The address to send the email from, in the format `Name `. You can set `from` or `from_id`, but not both. Use one of the `address` values from [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/)." }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 } }, "example": { "name": "Weekly Product Update", "type": "email", "recipients": { "and": [ { "or": [ { "segment": { "id": 42 } }, { "segment": { "id": 99 } } ] }, { "attribute": { "field": "plan", "operator": "eq", "value": "trial", "inverse": true } } ] }, "subject": "What's new this week, {{ customer.first_name }}", "preheader_text": "Check out our latest features and improvements", "body": "

Product Updates

Here's what we shipped this week...

", "from": "Product Team ", "subscription_topic_id": 5 } } ] }, { "title": "SMS", "description": "When creating an SMS text, you must include `body`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "twilio" ] }, "body": { "type": "string", "description": "The body content of the SMS message.", "example": "Hi {{ customer.first_name }}, your order has shipped!" } } } ] }, { "title": "Push", "description": "For push notifications, you must provide at least one of `subject` or `body`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "push" ] }, "subject": { "type": "string", "description": "The title of the push notification. You must provide `subject`, `body`, or both.", "example": "24-hour flash sale!" }, "body": { "type": "string", "description": "The body content of the push notification. You must provide `subject`, `body`, or both.", "example": "Get 30% off everything. Tap to shop now." } } } ] }, { "title": "In-App", "description": "For in-app messages, you must include `body_json`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body_json" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "in_app" ] }, "body_json": { "type": "string", "description": "JSON body content for the in-app message, as a stringified JSON object—a JSON string, not a nested object. It supports these fields:\n- `message_id`—string, an identifier for the message\n- `carta_content`—string, the message content markup from our in-app editor\n- `display`—object; `mode` (`modal`, `overlay`, `inline`, or `tooltip`) and `value` (the position for modals: `top`, `center`, or `bottom`; the position ID for inline messages). Tooltips take a `tooltip_target` CSS selector instead of `value`\n- `priority`—integer, delivery order for queued messages: `1` (low), `5` (medium), or `10` (high)\n- `expiration`—object; if omitted, the message expires after 30 days (60 maximum). Set `type` (`relative` or `absolute`), `unit`, and `value`\n- `persistent`—boolean, keep the message visible across pages and sessions until your audience dismisses it\n- `attributes`—object, custom key-value string pairs delivered with the message\n- `route_rules` and `excluded_route_rules`—objects keyed by platform (`web`, `ios`, or `android`), each holding an array of [page rules](/messaging/channels/in-app/send-in-app-message/#page-rule) with an `operator` (`contains` or `equals`), a `value` (`*` is a wildcard), and an `order` (integer). You can only set page rules when you create a message, and platforms you don't set rules for won't show the message\n", "example": "{\"message_id\":\"welcome\",\"display\":{\"mode\":\"modal\",\"value\":\"center\"},\"carta_content\":\"Hello {{customer.first_name}}!\",\"route_rules\":{\"web\":[{\"operator\":\"contains\",\"value\":\"/dashboard\",\"order\":0}]},\"excluded_route_rules\":{\"web\":[{\"operator\":\"equals\",\"value\":\"/admin\",\"order\":0}]}}" } } } ] }, { "title": "Webhook", "description": "For webhooks, you must include `body`, `request_method`, and `url`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body", "request_method", "url" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "webhook" ] }, "body": { "type": "string", "description": "The body content of the webhook request.", "example": "{\"channel\":\"#marketing\",\"text\":\"Newsletter sent to {{ customer.email }}\"}" }, "request_method": { "type": "string", "description": "The HTTP method for the webhook request.", "enum": [ "DELETE", "GET", "POST", "PUT", "PATCH" ] }, "url": { "type": "string", "description": "The URL to send the webhook request to." } } } ] }, { "title": "Inbox message", "description": "For inbox messages, you must include `body_json`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body_json" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "inbox" ] }, "body_json": { "type": "string", "description": "JSON body content for the inbox message, as a stringified JSON object. The fields you include depend on how you [set up your inbox](/journeys/channels/in-app/inbox/setup/):\n- `topics`—array, topics your audience can filter by in their inbox\n- `type`—string, context that helps render the inbox message\n- `properties`—object, your message info like the title, body, link, and image\n- `expiration`—object; if omitted, the message expires after 30 days. Otherwise set `type` (`relative` or `absolute`), `unit` (`seconds`, `minutes`, `hours`, or `days`; relative only), and `value` (number of units, or a unix timestamp if absolute)\n", "example": "{\"topics\": [\"general\", \"updates\"], \"type\": \"notification\", \"expiration\": {\"type\": \"relative\", \"value\": \"30\", \"unit\": \"days\"}, \"properties\": {\"title\": \"Welcome!\", \"message\": \"Thanks for signing up\", \"link\": \"https://customer.io\"}}" } } } ] } ], "discriminator": { "propertyName": "type" } }, "createNewsletterCommon": { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, "createEmailNewsletter": { "title": "Email", "description": "When you create an email, include `subject` and `body`. Set either `from` or `from_id`, but not both. If you set neither, Customer.io uses your oldest verified sending address.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "subject", "body" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "email" ] }, "subject": { "type": "string", "description": "The subject line of the email." }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body": { "type": "string", "description": "The HTML body content of the email. Use standard HTML/CSS, not syntax unique to Design Studio." }, "body_plain": { "type": "string", "description": "The plaintext body of the email. If provided, this overwrites the auto-generated plaintext." }, "layout_id": { "type": "integer", "description": "The ID of the [layout](/journeys/channels/email/layouts/3-layouts-and-customerio/) you want to use for the email. If you don't set one, the email uses your workspace's default layout. Find a layout's ID in its URL." }, "from": { "type": "string", "description": "The address to send the email from, in the format `Name `. You can set `from` or `from_id`, but not both. Use one of the `address` values from [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/)." }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 } }, "example": { "name": "Weekly Product Update", "type": "email", "recipients": { "and": [ { "or": [ { "segment": { "id": 42 } }, { "segment": { "id": 99 } } ] }, { "attribute": { "field": "plan", "operator": "eq", "value": "trial", "inverse": true } } ] }, "subject": "What's new this week, {{ customer.first_name }}", "preheader_text": "Check out our latest features and improvements", "body": "

Product Updates

Here's what we shipped this week...

", "from": "Product Team ", "subscription_topic_id": 5 } } ] }, "createSmsNewsletter": { "title": "SMS", "description": "When creating an SMS text, you must include `body`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "twilio" ] }, "body": { "type": "string", "description": "The body content of the SMS message.", "example": "Hi {{ customer.first_name }}, your order has shipped!" } } } ] }, "createPushNewsletter": { "title": "Push", "description": "For push notifications, you must provide at least one of `subject` or `body`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "push" ] }, "subject": { "type": "string", "description": "The title of the push notification. You must provide `subject`, `body`, or both.", "example": "24-hour flash sale!" }, "body": { "type": "string", "description": "The body content of the push notification. You must provide `subject`, `body`, or both.", "example": "Get 30% off everything. Tap to shop now." } } } ] }, "createInAppNewsletter": { "title": "In-App", "description": "For in-app messages, you must include `body_json`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body_json" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "in_app" ] }, "body_json": { "type": "string", "description": "JSON body content for the in-app message, as a stringified JSON object—a JSON string, not a nested object. It supports these fields:\n- `message_id`—string, an identifier for the message\n- `carta_content`—string, the message content markup from our in-app editor\n- `display`—object; `mode` (`modal`, `overlay`, `inline`, or `tooltip`) and `value` (the position for modals: `top`, `center`, or `bottom`; the position ID for inline messages). Tooltips take a `tooltip_target` CSS selector instead of `value`\n- `priority`—integer, delivery order for queued messages: `1` (low), `5` (medium), or `10` (high)\n- `expiration`—object; if omitted, the message expires after 30 days (60 maximum). Set `type` (`relative` or `absolute`), `unit`, and `value`\n- `persistent`—boolean, keep the message visible across pages and sessions until your audience dismisses it\n- `attributes`—object, custom key-value string pairs delivered with the message\n- `route_rules` and `excluded_route_rules`—objects keyed by platform (`web`, `ios`, or `android`), each holding an array of [page rules](/messaging/channels/in-app/send-in-app-message/#page-rule) with an `operator` (`contains` or `equals`), a `value` (`*` is a wildcard), and an `order` (integer). You can only set page rules when you create a message, and platforms you don't set rules for won't show the message\n", "example": "{\"message_id\":\"welcome\",\"display\":{\"mode\":\"modal\",\"value\":\"center\"},\"carta_content\":\"Hello {{customer.first_name}}!\",\"route_rules\":{\"web\":[{\"operator\":\"contains\",\"value\":\"/dashboard\",\"order\":0}]},\"excluded_route_rules\":{\"web\":[{\"operator\":\"equals\",\"value\":\"/admin\",\"order\":0}]}}" } } } ] }, "inAppBodyJson": { "type": "string", "description": "JSON body content for the in-app message, as a stringified JSON object—a JSON string, not a nested object. It supports these fields:\n- `message_id`—string, an identifier for the message\n- `carta_content`—string, the message content markup from our in-app editor\n- `display`—object; `mode` (`modal`, `overlay`, `inline`, or `tooltip`) and `value` (the position for modals: `top`, `center`, or `bottom`; the position ID for inline messages). Tooltips take a `tooltip_target` CSS selector instead of `value`\n- `priority`—integer, delivery order for queued messages: `1` (low), `5` (medium), or `10` (high)\n- `expiration`—object; if omitted, the message expires after 30 days (60 maximum). Set `type` (`relative` or `absolute`), `unit`, and `value`\n- `persistent`—boolean, keep the message visible across pages and sessions until your audience dismisses it\n- `attributes`—object, custom key-value string pairs delivered with the message\n- `route_rules` and `excluded_route_rules`—objects keyed by platform (`web`, `ios`, or `android`), each holding an array of [page rules](/messaging/channels/in-app/send-in-app-message/#page-rule) with an `operator` (`contains` or `equals`), a `value` (`*` is a wildcard), and an `order` (integer). You can only set page rules when you create a message, and platforms you don't set rules for won't show the message\n", "example": "{\"message_id\":\"welcome\",\"display\":{\"mode\":\"modal\",\"value\":\"center\"},\"carta_content\":\"Hello {{customer.first_name}}!\",\"route_rules\":{\"web\":[{\"operator\":\"contains\",\"value\":\"/dashboard\",\"order\":0}]},\"excluded_route_rules\":{\"web\":[{\"operator\":\"equals\",\"value\":\"/admin\",\"order\":0}]}}" }, "inboxBodyJson": { "type": "string", "description": "JSON body content for the inbox message, as a stringified JSON object. The fields you include depend on how you [set up your inbox](/journeys/channels/in-app/inbox/setup/):\n- `topics`—array, topics your audience can filter by in their inbox\n- `type`—string, context that helps render the inbox message\n- `properties`—object, your message info like the title, body, link, and image\n- `expiration`—object; if omitted, the message expires after 30 days. Otherwise set `type` (`relative` or `absolute`), `unit` (`seconds`, `minutes`, `hours`, or `days`; relative only), and `value` (number of units, or a unix timestamp if absolute)\n", "example": "{\"topics\": [\"general\", \"updates\"], \"type\": \"notification\", \"expiration\": {\"type\": \"relative\", \"value\": \"30\", \"unit\": \"days\"}, \"properties\": {\"title\": \"Welcome!\", \"message\": \"Thanks for signing up\", \"link\": \"https://customer.io\"}}" }, "createInboxNewsletter": { "title": "Inbox message", "description": "For inbox messages, you must include `body_json`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body_json" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "inbox" ] }, "body_json": { "type": "string", "description": "JSON body content for the inbox message, as a stringified JSON object. The fields you include depend on how you [set up your inbox](/journeys/channels/in-app/inbox/setup/):\n- `topics`—array, topics your audience can filter by in their inbox\n- `type`—string, context that helps render the inbox message\n- `properties`—object, your message info like the title, body, link, and image\n- `expiration`—object; if omitted, the message expires after 30 days. Otherwise set `type` (`relative` or `absolute`), `unit` (`seconds`, `minutes`, `hours`, or `days`; relative only), and `value` (number of units, or a unix timestamp if absolute)\n", "example": "{\"topics\": [\"general\", \"updates\"], \"type\": \"notification\", \"expiration\": {\"type\": \"relative\", \"value\": \"30\", \"unit\": \"days\"}, \"properties\": {\"title\": \"Welcome!\", \"message\": \"Thanks for signing up\", \"link\": \"https://customer.io\"}}" } } } ] }, "createWebhookNewsletter": { "title": "Webhook", "description": "For webhooks, you must include `body`, `request_method`, and `url`.", "allOf": [ { "type": "object", "required": [ "name", "type", "recipients" ], "properties": { "name": { "type": "string", "maxLength": 190, "description": "The name of the newsletter." }, "recipients": { "type": "object", "description": "Filter conditions that define the newsletter's recipients. Combine `segment` and `attribute` conditions with `and`, `or`, and `not` operators.\n\nThis endpoint enforces a strict shape:\n\n* The outermost object must be a single `and` array.\n* Every operator or condition object takes exactly **one** key: `and`, `or`, `not`, `segment`, or `attribute`. An object with two keys—like `not` alongside `and`—is rejected with an \"Invalid filter spec\" error.\n* Segment conditions must be wrapped in an `or` array, even for a single segment—and `or` arrays can contain only segment conditions.\n* To exclude segments, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array.\n* Attribute conditions sit directly in the `and` array, unwrapped. To negate an attribute condition, set `inverse: true` on the attribute itself—`not` can't contain attribute conditions.\n\nThe email example on this operation shows or-wrapped segments combined with a negated attribute; for the common \"include segment A, exclude segment B\" pattern, see the **include one segment, exclude another** request example. See [Format API-triggered broadcasts](/messaging/send/broadcasts/api-triggered-data-format/#overriding-recipients) for general operator behavior.\n", "properties": { "and": { "type": "array", "description": "An array of conditions that must all be true.", "items": { "type": "object" } }, "or": { "type": "array", "description": "An array of conditions where at least one must be true. On this endpoint, `or` arrays can contain only segment conditions.", "items": { "type": "object" } }, "not": { "type": "object", "description": "A condition or group of conditions to exclude. On this endpoint, `not` must contain an `or` of segment conditions and sit as its own item inside the `and` array. An object with both `and` and `not` keys is rejected with an \"Invalid filter spec\" error." }, "segment": { "type": "object", "description": "A segment condition.", "properties": { "id": { "type": "integer", "description": "The ID of a segment." } } }, "attribute": { "type": "object", "description": "A customer attribute condition.", "properties": { "field": { "type": "string", "description": "The attribute name." }, "operator": { "type": "string", "description": "The comparison operator.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value to compare against. Required when `operator` is `eq`." }, "inverse": { "type": "boolean", "description": "Set to `true` for \"is not equal\" or \"does not exist\"." } } } } }, "send_now": { "type": "boolean", "description": "If `true`, the newsletter is sent immediately after creation. You cannot set both `send_now` and `scheduled_at`." }, "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "A Unix timestamp indicating when to send the newsletter. The time must be in the future. You cannot set both `send_now` and `scheduled_at`." }, "subscription_topic_id": { "type": "integer", "description": "The newsletter audience's subscription topic ID. Required when [subscription center](/journeys/channels/subscriptions/center/#enable-sub-center) is enabled; otherwise sends to globally subscribed profiles." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, { "type": "object", "required": [ "body", "request_method", "url" ], "properties": { "type": { "type": "string", "description": "The channel type for the newsletter.", "enum": [ "webhook" ] }, "body": { "type": "string", "description": "The body content of the webhook request.", "example": "{\"channel\":\"#marketing\",\"text\":\"Newsletter sent to {{ customer.email }}\"}" }, "request_method": { "type": "string", "description": "The HTTP method for the webhook request.", "enum": [ "DELETE", "GET", "POST", "PUT", "PATCH" ] }, "url": { "type": "string", "description": "The URL to send the webhook request to." } } } ] }, "createLanguageVariantRequest": { "description": "Add a language variant to a newsletter. The payload the endpoint accepts depends on the parent newsletter's channel type.", "oneOf": [ { "title": "Email", "description": "Add a language variant to an email newsletter. Requires `language`, `subject`, and `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "subject", "body" ], "properties": { "subject": { "type": "string", "description": "The subject line for the variant.", "example": "¡Hola, {{ customer.name }}!" }, "preheader_text": { "type": "string", "description": "The preheader text for the email variant.", "example": "Mira nuestras últimas novedades" }, "body": { "type": "string", "description": "The HTML body content for the variant.", "example": "

¡Hola!

" }, "body_plain": { "type": "string", "description": "The plaintext body content for the variant." }, "body_amp": { "type": "string", "description": "The AMP HTML body content for the variant." } } } ] }, { "title": "SMS", "description": "Add a language variant to an SMS newsletter. Requires `language` and `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "description": "The body content of the SMS message.", "example": "¡Hola {{ customer.first_name }}! Tu pedido ha sido enviado." } } } ] }, { "title": "Push", "description": "Add a language variant to a push notification newsletter. Requires `language` and at least one of `subject` or `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "properties": { "subject": { "type": "string", "description": "The title of the push notification.", "example": "¡Oferta por tiempo limitado!" }, "body": { "type": "string", "description": "The body content of the push notification.", "example": "Obtén 30% de descuento en todo." } } } ] }, { "title": "Webhook", "description": "Add a language variant to a webhook newsletter. Requires `language` and `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "description": "The body content of the webhook request.", "example": "{\"channel\":\"#marketing\",\"text\":\"Boletín enviado a {{ customer.email }}\"}" } } } ] }, { "title": "Inbox message", "description": "Add a language variant to an inbox message newsletter. Requires `language` and `body_json`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body_json" ], "properties": { "body_json": { "type": "string", "description": "JSON body content for the inbox message variant. Learn more about [message settings](/journeys/channels/in-app/inbox/send-inbox/) in our docs.", "example": "{\"topics\": [\"general\", \"updates\"], \"type\": \"notification\", \"expiration\": {\"type\": \"relative\", \"value\": \"30\", \"unit\": \"days\"}, \"properties\": {\"title\": \"Welcome!\", \"message\": \"Thanks for signing up\", \"link\": \"https://customer.io\"}}" } } } ] } ] }, "createLanguageVariantCommon": { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, "createEmailLanguageVariant": { "title": "Email", "description": "Add a language variant to an email newsletter. Requires `language`, `subject`, and `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "subject", "body" ], "properties": { "subject": { "type": "string", "description": "The subject line for the variant.", "example": "¡Hola, {{ customer.name }}!" }, "preheader_text": { "type": "string", "description": "The preheader text for the email variant.", "example": "Mira nuestras últimas novedades" }, "body": { "type": "string", "description": "The HTML body content for the variant.", "example": "

¡Hola!

" }, "body_plain": { "type": "string", "description": "The plaintext body content for the variant." }, "body_amp": { "type": "string", "description": "The AMP HTML body content for the variant." } } } ] }, "createSmsLanguageVariant": { "title": "SMS", "description": "Add a language variant to an SMS newsletter. Requires `language` and `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "description": "The body content of the SMS message.", "example": "¡Hola {{ customer.first_name }}! Tu pedido ha sido enviado." } } } ] }, "createPushLanguageVariant": { "title": "Push", "description": "Add a language variant to a push notification newsletter. Requires `language` and at least one of `subject` or `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "properties": { "subject": { "type": "string", "description": "The title of the push notification.", "example": "¡Oferta por tiempo limitado!" }, "body": { "type": "string", "description": "The body content of the push notification.", "example": "Obtén 30% de descuento en todo." } } } ] }, "createInAppLanguageVariant": { "title": "In-App", "description": "Add a language variant to an in-app message newsletter. Requires `language` and `body_json`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body_json" ], "properties": { "body_json": { "type": "string", "description": "JSON body content for the in-app message variant, as a stringified JSON object. Takes the same fields as the parent message's `body_json`.", "example": "{\"message_id\":\"welcome\",\"carta_content\":\"¡Hola!\"}" } } } ] }, "createInboxLanguageVariant": { "title": "Inbox message", "description": "Add a language variant to an inbox message newsletter. Requires `language` and `body_json`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body_json" ], "properties": { "body_json": { "type": "string", "description": "JSON body content for the inbox message variant. Learn more about [message settings](/journeys/channels/in-app/inbox/send-inbox/) in our docs.", "example": "{\"topics\": [\"general\", \"updates\"], \"type\": \"notification\", \"expiration\": {\"type\": \"relative\", \"value\": \"30\", \"unit\": \"days\"}, \"properties\": {\"title\": \"Welcome!\", \"message\": \"Thanks for signing up\", \"link\": \"https://customer.io\"}}" } } } ] }, "createWebhookLanguageVariant": { "title": "Webhook", "description": "Add a language variant to a webhook newsletter. Requires `language` and `body`.", "allOf": [ { "type": "object", "required": [ "language" ], "properties": { "language": { "type": "string", "description": "The [language tag](/journeys/channels/localization/attribute/#supported-languages) for the new variant, e.g. `es`, `fr`, `de`.", "example": "es" } } }, { "type": "object", "required": [ "body" ], "properties": { "body": { "type": "string", "description": "The body content of the webhook request.", "example": "{\"channel\":\"#marketing\",\"text\":\"Boletín enviado a {{ customer.email }}\"}" } } } ] }, "newsletterRateLimitOptions": { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } }, "newsletterScheduleRequest": { "type": "object", "example": { "scheduled_at": 1719849600, "timezone": "America/New_York", "tz_match_enabled": false, "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "allOf": [ { "type": "object", "required": [ "scheduled_at" ], "properties": { "scheduled_at": { "type": "integer", "format": "unix timestamp", "description": "Unix timestamp for the send. Use `0` to deschedule. When greater than `0`, the time must be in the future and you must send `timezone` so the UI displays the time correctly.\n" }, "timezone": { "type": "string", "description": "[IANA timezone name](/journeys/send/timezones/example-timezones/#region-format) (for example, `America/New_York`). Required when `scheduled_at` is greater than `0`. Not required when descheduling (`scheduled_at` is `0`).\n" }, "tz_match_enabled": { "type": "boolean", "description": "When `true`, sends at the same local time in each recipient's timezone. If it's set to `true` and `rate_limit_time_period` is provided, then the period can't be greater than `3600` (1 hour)." } } }, { "type": "object", "example": { "rate_limit_email_rate": 500, "rate_limit_time_period": 60, "rate_limit_spread": true }, "description": "Optional newsletter rate limiting. If you set `rate_limit_email_rate` or `rate_limit_time_period`, set both; `rate_limit_spread` can be set alone.", "properties": { "rate_limit_email_rate": { "type": "integer", "minimum": 1, "description": "Maximum number of messages per time period. **NOTE:** Though this states `email_rate`, you can use this for other message channels. Only fixed rate limits are supported, not [daily ramp limits](/journeys/send/broadcasts/newsletters/#daily-ramp).\n" }, "rate_limit_time_period": { "type": "integer", "enum": [ 60, 3600, 86400 ], "description": "Time period in seconds for rate limiting. Must be one of 60 (minute), 3600 (hour), or 86400 (day)." }, "rate_limit_spread": { "type": "boolean", "description": "When `true`, spreads messages evenly across the time period. Otherwise, it sends as fast as possible up to the limit in each period." } } } ] }, "newsletterObject": { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for a newsletter.", "type": "integer", "example": 10 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "content_ids": { "type": "array", "description": "A list of message variants in a newsletter, where a variant is a translation or A/B test.", "items": { "type": "integer" } }, "name": { "type": "string", "description": "The name of the newsletter. Must be 190 characters or less.", "readOnly": true }, "sent_at": { "type": "integer", "format": "unix timestamp", "description": "The last time the newsletter was sent." }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "tags": { "type": "array", "description": "An array of tags associated with the newsletter.", "items": { "type": "string" } }, "recipient_segment_ids": { "description": "If the recipient conditions included segments, this returns a list of those segment ids.", "type": "array", "items": { "type": "integer" } }, "subscription_topic_id": { "type": "integer", "description": "If you enabled a [subscription center](/journeys/channels/subscriptions/center/) on your workspace, this returns the id of the subscription preference you set." } }, "example": { "id": 128275, "deduplicate_id": "128275:1484870424", "type": "email", "content_ids": [ 45 ], "name": "Weekly Product Update", "sent_at": 1481653929, "created": 1481653919, "updated": 1481653929, "recipient_segment_ids": [ 42, 99 ], "tags": [ "Product Updates" ], "subscription_topic_id": 5 } }, "customer_events": { "x-scalar-ignore": true, "description": "Describes the customer events reported from Customer.io to a webhook.", "type": "object", "properties": { "customer_subscribed": { "type": "boolean", "description": "A person's `unsubscribed` attribute was explicitly set to `false`. Set to true to report `subscribed` events." }, "customer_unsubscribed": { "type": "boolean", "description": "A person's `unsubscribed` attribute was explicitly set to `true`. Set to true to report `unsubscribed` events." }, "customer_subscription_preferences_changed": { "type": "boolean", "description": "A person's subscription preferences changed. [Learn more about the subscription center](/journeys/channels/subscriptions/center/)." } } }, "email_events": { "x-scalar-ignore": true, "type": "object", "description": "Describes the email events reported from Customer.io to a webhook.", "properties": { "email_attempted": { "type": "boolean", "description": "Reports when a message cannot be sent to the delivery provider and will retry. Set to true to report this event type." }, "email_bounced": { "type": "boolean", "description": "Reports when the delivery provider is unable to deliver a message. Set to true to report this event type." }, "email_clicked": { "type": "boolean", "description": "Reports when a person clicks a tracked link in a message. Set to true to report this event type." }, "email_converted": { "type": "boolean", "description": "Reports a conversion. Set to true to report this event type." }, "email_deferred": { "type": "boolean", "description": "Reports when the delivery provider couldn't send a message and will retry. Set to true to report this event type." }, "email_delivered": { "type": "boolean", "description": "Reports when the delivery provider reports that a message is delivered to an inbox. Set to true to report this event type." }, "email_drafted": { "type": "boolean", "description": "Reports when a message draft is created. Set to true to report this event type." }, "email_dropped": { "type": "boolean", "description": "Reports when a message isn't sent because the recipient is suppressed. Set to true to report this event type." }, "email_failed": { "type": "boolean", "description": "Reports when an email couldn't be sent to the delivery provider. Set to true to report this event type." }, "email_opened": { "type": "boolean", "description": "Reports when a recipient opens a message. Set to true to report this event type." }, "email_sent": { "type": "boolean", "description": "Reports when a message is sent from Customer.io to the delivery provider. Set to true to report this event type." }, "email_spammed": { "type": "boolean", "description": "Reports a recipient marks a message as spam. Set to true to report this even type." }, "email_unsubscribed": { "type": "boolean", "description": "Reports when a person unsubscribes through a particular email. Set to true to report this event type." } } }, "push_events": { "x-scalar-ignore": true, "type": "object", "description": "Describes the push events reported from Customer.io to a webhook.", "properties": { "push_attempted": { "type": "boolean", "description": "Reports when a push notification could not be sent to the delivery provider will retry. Set to true to report this event type." }, "push_bounced": { "type": "boolean", "description": "Reports when the delivery provider is unable to deliver a message. Set to true to report this event type." }, "push_clicked": { "type": "boolean", "description": "Reports when a person clicks a tracked link in a message. Set to true to report this event type." }, "push_converted": { "type": "boolean", "description": "Reports a conversion. Set to true to report this event type." }, "push_delivered": { "type": "boolean", "description": "An app reports that the recipient's device received a message. Set to true to report this event type." }, "push_drafted": { "type": "boolean", "description": "Reports when a message draft is created. Set to true to report this event type." }, "push_dropped": { "type": "boolean", "description": "Reports when a message isn't sent because the recipient is suppressed. Set to true to report this event type." }, "push_failed": { "type": "boolean", "description": "Reports when a message couldn't be sent to the delivery provider. Set to true to report this event type." }, "push_opened": { "type": "boolean", "description": "The app on a recipient's device reports that the recipient opened the message. Set to true to report this event type." }, "push_sent": { "type": "boolean", "description": "Reports when a message is sent from Customer.io to the delivery provider. Set to true to report this event type." } } }, "sms_events": { "x-scalar-ignore": true, "type": "object", "description": "Describes the SMS events reported from Customer.io to a webhook.", "properties": { "sms_attempted": { "type": "boolean", "description": "Reports when a push notification could not be sent to the delivery provider will retry. Set to true to report this event type." }, "sms_bounced": { "type": "boolean", "description": "Reports when the delivery provider is unable to deliver a message to the recipient. Set to true to report this event type." }, "sms_clicked": { "type": "boolean", "description": "Reports when a person clicks a tracked link in a message. Set to true to report this event type." }, "sms_converted": { "type": "boolean", "description": "Reports when a person matches conversion criteria attributed to a a message. Set to true to report this event type." }, "sms_delivered": { "type": "boolean", "description": "The delivery provider reports that the message is delivered. Set to true to report this event type." }, "sms_drafted": { "type": "boolean", "description": "Reports when a message draft is created. Set to true to report this event type." }, "sms_failed": { "type": "boolean", "description": "Reports when a message couldn't be sent to the delivery provider. Set to true to report this event type." }, "sms_sent": { "type": "boolean", "description": "Reports when a message is sent from Customer.io to the delivery provider. Set to true to report this event type." } } }, "slack_events": { "x-scalar-ignore": true, "type": "object", "description": "Describes the slack events reported from Customer.io to a webhook.", "properties": { "slack_attempted": { "type": "boolean", "description": "Reports when a message could not be sent to the delivery provider will retry. Set to true to report this event type." }, "slack_clicked": { "type": "boolean", "description": "Reports when a person clicks a tracked link in a message. Set to true to report this event type." }, "slack_converted": { "type": "boolean", "description": "Reports when a person matches conversion criteria attributed to a a message. Set to true to report this event type." }, "slack_drafted": { "type": "boolean", "description": "Reports when a message draft is created. Set to true to report this event type." }, "slack_failed": { "type": "boolean", "description": "Reports when a message couldn't be sent to the delivery provider. Set to true to report this event type." }, "slack_sent": { "type": "boolean", "description": "Reports when a message is sent from Customer.io to the delivery provider. Set to true to report this event type." } } }, "webhook_events": { "x-scalar-ignore": true, "type": "object", "description": "Describes the webhook events reported from Customer.io to a webhook.", "properties": { "webhook_attempted": { "type": "boolean", "description": "Reports when a webhook could not be sent and will retry. Set to true to report this event type." }, "webhook_clicked": { "type": "boolean", "description": "Reports when a tracked link in a webhook payload is opened. Set to true to report this event type." }, "webhook_drafted": { "type": "boolean", "description": "A webhook draft is created. Set to true to report this event type." }, "webhook_failed": { "type": "boolean", "description": "Reports when a webhook couldn't be sent to the webhook URL. Set to true to report this event type." }, "webhook_sent": { "type": "boolean", "description": "Reports when a webhook is sent from Customer.io to the webhook URL. Set to true to report this event type." } } }, "body_content": { "x-scalar-ignore": true, "type": "string", "description": "Message content in reporting webhooks when Body Content is enabled and the metric is `sent`. Email content includes headers; push and in-app content is stringified payload." }, "reportingWebhook": { "x-scalar-ignore": true, "type": "object", "required": [ "name", "endpoint", "events" ], "properties": { "name": { "type": "string", "description": "The name of your webhook.", "example": "my cool webhook" }, "id": { "type": "integer", "description": "The identifier for the webhook.", "readOnly": true, "example": 4 }, "type": { "type": "string", "description": "The type of webhook—`webhook` for a standard reporting webhook or `js` for a JavaScript webhook.", "enum": [ "webhook", "js" ], "readOnly": true, "example": "webhook" }, "endpoint": { "type": "string", "format": "url", "description": "The webhook URL.", "example": "https://example.com/webhook" }, "disabled": { "type": "boolean", "description": "Set to `true` to quit sending events to the webhook URL. Set to `false` to enable the webhook.", "example": false }, "full_resolution": { "type": "boolean", "description": "Set to `false` to send unique open and click events to the webhook. Set to `true` to send all events.", "default": false, "example": true }, "with_content": { "type": "boolean", "description": "Set to `true` to include the message `body` in `_sent` events.", "example": false }, "events": { "description": "Specifies the types of events you want to report to your webhook. See our [reporting webhooks reference](/integrations/api/webhooks/) for more information about event types and the information they return.", "type": "array", "minItems": 1, "items": { "type": "string", "enum": [ "customer_subscribed", "customer_unsubscribed", "customer_subscription_preferences_changed", "email_drafted", "email_attempted", "email_sent", "email_delivered", "email_opened", "email_clicked", "email_converted", "email_bounced", "email_dropped", "email_deferred", "email_spammed", "email_failed", "email_unsubscribed", "email_undeliverable", "in_app_drafted", "in_app_attempted", "in_app_sent", "in_app_opened", "in_app_clicked", "in_app_converted", "in_app_failed", "in_app_undeliverable", "push_drafted", "push_attempted", "push_sent", "push_delivered", "push_opened", "push_clicked", "push_converted", "push_bounced", "push_dropped", "push_failed", "push_undeliverable", "slack_drafted", "slack_attempted", "slack_sent", "slack_clicked", "slack_converted", "slack_failed", "sms_drafted", "sms_attempted", "sms_sent", "sms_delivered", "sms_clicked", "sms_converted", "sms_bounced", "sms_dropped", "sms_failed", "sms_undeliverable", "sms_replied", "whatsapp_drafted", "whatsapp_attempted", "whatsapp_sent", "whatsapp_delivered", "whatsapp_opened", "whatsapp_clicked", "whatsapp_converted", "whatsapp_bounced", "whatsapp_dropped", "whatsapp_failed", "whatsapp_undeliverable", "whatsapp_replied", "webhook_drafted", "webhook_attempted", "webhook_sent", "webhook_clicked", "webhook_converted", "webhook_failed", "webhook_undeliverable" ] }, "example": [ "email_failed", "webhook_failed" ] } } }, "url": { "x-scalar-ignore": true, "type": "string", "description": "The URL of a webhook or action.", "example": "https://example.com/webhook" }, "request_method": { "x-scalar-ignore": true, "type": "string", "description": "The method used in conjunction with a webhook `url`.", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH" ], "example": "POST" }, "forgotten": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, Customer.io does not retain the message content.", "example": false }, "archivedMessageObject": { "x-scalar-ignore": true, "description": "An archived message, including a complete message body.\n", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for a delivery—the instance of a message intended for an individual recipient.", "type": "string", "readOnly": true, "example": "dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=" }, "body": { "type": "string", "description": "The body of the variant. You cannot modify the body if you created it with our drag-and-drop editor.", "example": "\\n

Hello World

\\n\\n" }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "recipient": { "description": "The recipient address for an action.", "type": "string", "example": "person@example.com" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "url": { "x-scalar-ignore": true, "type": "string", "description": "The URL of a webhook or action.", "example": "https://example.com/webhook" }, "request_method": { "x-scalar-ignore": true, "type": "string", "description": "The method used in conjunction with a webhook `url`.", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH" ], "example": "POST" }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "forgotten": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, Customer.io does not retain the message content.", "example": false } } }, "commonTriggerProps": { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } }, "campaignRequest": { "x-scalar-ignore": true, "oneOf": [ { "title": "Default audience", "description": "Send your broadcast to the default set of recipients defined in the UI.", "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } } ] }, { "title": "Custom recipients", "description": "Send your broadcast to a group of people defined by a set of filters.", "allOf": [ { "type": "object", "required": [ "recipients" ], "properties": { "recipients": { "x-scalar-ignore": true, "title": "Audience Filter", "description": "Use `and`, `or`, and `not` to combine segment and attribute conditions. The top-level object accepts one property; nest groups for complex filters.", "oneOf": [ { "x-scalar-ignore": true, "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "type": "object", "properties": { "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "x-scalar-ignore": true, "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "type": "object", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "x-scalar-ignore": true, "title": "not", "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "title": "People Filter", "type": "object", "description": "Filter people with `and`, `or`, and `not` groups made from `segment` and `attribute` conditions.", "properties": { "and": { "type": "array", "description": "Returns results matching *all* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "or": { "type": "array", "description": "Returns results matching *any* conditions.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } }, "not": { "description": "Returns results if a condition is false. While and/or support an array of items, `not` supports a single filter object.", "oneOf": [ { "title": "and", "type": "object", "properties": { "and": { "type": "array", "description": "Match *all* conditions to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "or", "type": "object", "properties": { "or": { "type": "array", "description": "Match *any* condition to return results.", "items": { "x-scalar-ignore": true, "anyOf": [ { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } }, "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } } } }, { "title": "segment", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "attribute", "type": "object", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] }, { "title": "segment", "description": "Filter for people who belong to a segment.", "type": "object", "properties": { "segment": { "x-scalar-ignore": true, "title": "segment", "type": "object", "description": "Provide the `id` of a segment containing people you want to search for.", "properties": { "id": { "type": "integer", "description": "The ID of the segment you want to return people from.", "example": 4 } } } } }, { "title": "audience", "type": "object", "description": "filter for people who have an attribute or an attribute value.", "properties": { "attribute": { "x-scalar-ignore": true, "title": "attribute", "description": "Filter your audience by attribute.", "type": "object", "required": [ "field", "operator" ], "properties": { "field": { "type": "string", "description": "The name of the attribute you want to filter against.", "example": "first_name" }, "operator": { "type": "string", "description": "Determine how to evaluate criteria against the field—`exists` returns results if a person in the audience has the attribute; `eq` returns results if the audience has the attribute and the attribute has the `value` you specify.", "enum": [ "eq", "exists" ] }, "value": { "type": "string", "description": "The value you want to match for this attribute. You must include a value if you use the `eq` operator." } }, "example": { "field": "unsubscribed", "operator": "eq", "value": true } } } } ] } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } } ], "example": { "recipients": { "and": [ { "segment": { "id": 3 } }, { "or": [ { "attribute": { "field": "interest", "operator": "eq", "value": "roadrunners" } }, { "attribute": { "field": "state", "operator": "eq", "value": "NM" } }, { "not": { "attribute": { "field": "species", "operator": "eq", "value": "roadrunners" } } } ] } ] }, "data": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } } }, { "title": "Emails", "description": "An array of emails you want to send the broadcast to. These addresses must already exist; your request cannot create a new person.", "allOf": [ { "type": "object", "required": [ "emails" ], "properties": { "emails": { "description": "An array of email addresses you want to send the broadcast to. These addresses must already exist; your request cannot create a new person.", "type": "array", "items": { "type": "string", "format": "email" }, "example": [ "recipient1@example.com", "anotherRecipient@example.com" ] } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } } ] }, { "title": "IDs", "description": "An array of customer ids that you want to send the broadcast to. These IDs must already exist; your request cannot create a new person.", "allOf": [ { "type": "object", "required": [ "ids" ], "properties": { "ids": { "description": "An array of IDs you want to send a broadcast to. **NOTE**: If your workspace identifies people by `email`, don't use this option. Identify your audience by `emails` instead.\n", "type": "array", "maxItems": 10000, "items": { "type": "string" }, "example": [ "id1", "id4" ] } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } } ] }, { "title": "User Maps", "description": "An array of JSON objects containing `id` or `email` keys and a `data` key. Each object represents a person you want to send the broadcast to and data you want to personalize their message with using liquid.", "allOf": [ { "type": "object", "required": [ "per_user_data" ], "properties": { "per_user_data": { "description": "The people you want to send a broadcast to, with custom data to personalize each message. Each person must already exist in your workspace—a broadcast trigger can't create people.", "type": "array", "maxItems": 10000, "items": { "oneOf": [ { "title": "ids", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The ID of the recipient.", "example": 1 }, "data": { "type": "object", "description": "Merge data associated with the recipient.", "additionalProperties": { "x-additionalPropertiesName": "Liquid merge data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "firstName": "Hugh", "lastName": "Mann", "purchase": "shoes" } } } }, { "title": "emails", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The email address of the recipient. This address must be unique in your workspace. If more than one person has the same `email` attribute, your request will produce an error.", "example": "recipient1@example.com" }, "data": { "description": "Merge data associated with the recipient.", "type": "object", "additionalProperties": { "x-additionalPropertiesName": "Liquid merge data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "firstName": "Hugh", "lastName": "Mann", "purchase": "shoes" } } } } ] }, "example": [ { "id": "wiley_coyote", "data": { "voucher_code": "FESwYm" } }, { "email": "road@runner.net", "data": { "voucher_code": "cYm6XJ" } } ] } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } } ] }, { "title": "Data file URL", "description": "The URL of a data file with one JSON object per line, using either `id` and `data` or `email` and `data`. The people you reference must already exist in your workspace. The file may be gzip-compressed to reduce transfer size (recommended for large files); if compressed, it must use gzip and the hosting server must return a `Content-Encoding` header set to `gzip` when the file is downloaded.", "allOf": [ { "type": "object", "required": [ "data_file_url" ], "properties": { "data_file_url": { "description": "The URL of a JSON Lines file with one person per line, using `id` and `data` or `email` and `data`. The people you reference must already exist in your workspace. The file may be gzip-compressed to reduce transfer size (recommended for large files); if compressed, it must use gzip and the hosting server must return a `Content-Encoding` header set to `gzip` when the file is downloaded.", "type": "string", "format": "url", "example": "https://myFile.example.com" } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "data": { "type": "object", "description": "Contains information you want to use to populate your broadcast.", "additionalProperties": { "x-additionalPropertiesName": "Broadcast liquid data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "headline": "Roadrunner spotted in Albuquerque!", "date": 1511315635, "text": "We received reports of a roadrunner in your immediate area! Head to your dashboard to view more information!" } }, "email_add_duplicates": { "type": "boolean", "default": false, "description": "an email address associated with more than one profile id is an error." }, "email_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing email causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have emails, and continue sending to the rest of your audience." }, "id_ignore_missing": { "type": "boolean", "default": false, "description": "If false, a missing customer ID causes the broadcast to error and fail. If true, the broadcast will skip over any people in your audience who don't have IDs, and continue sending to the rest of your audience." } } } ] } ] }, "customer_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" }, "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_identifiers": { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, "not_nullable_customer_id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" }, "not_nullable_email_address": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" }, "email_address": { "x-scalar-ignore": true, "type": [ "string", "null" ], "description": "The email address of the customer.", "example": "test@example.com" }, "device_id": { "x-scalar-ignore": true, "type": "string", "description": "The identifier for a person's device—typically a device token." }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "segment_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a segment; used to target a segment in requests.", "example": 7 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "segment_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the segment.", "example": "Manual Segment 1" }, "segment_description": { "x-scalar-ignore": true, "type": "string", "description": "A description for the segment. This can help you understand the purpose of the segment when you encounter it in other requests or in the UI.", "example": "My first manual segment" }, "segmentResponseObject": { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a segment; used to target a segment in requests.", "example": 7 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the segment.", "example": "Manual Segment 1" }, "description": { "x-scalar-ignore": true, "type": "string", "description": "A description for the segment. This can help you understand the purpose of the segment when you encounter it in other requests or in the UI.", "example": "My first manual segment" }, "state": { "type": "string", "description": "The segment build state:\n- `events`—handling event conditions for this segment\n- `build`—handling profile attribute conditions for this segment\n- `events_queued`—waiting to start handling event conditions\n- `build_queued`—waiting to start handling profile attribute conditions\n- `finished`—the segment is finished building\n", "enum": [ "events", "build", "events_queued", "build_queued", "finished" ] }, "progress": { "type": [ "integer", "null" ], "description": "If Customer.io has not finished processing the segment, this indicates the percentage complete. Otherwise, this key is null.", "example": null }, "type": { "type": "string", "description": "The type of segment.", "enum": [ "dynamic", "manual" ], "example": "manual" }, "tags": { "type": [ "array", "null" ], "description": "The tags assigned to the segment, if any. Tags may help you sort through your segments.", "items": { "type": "string" }, "example": null }, "created_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true } } }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "msg_template_ids": { "x-scalar-ignore": true, "type": "array", "deprecated": true, "description": "Indicates the message template(s) used in this broadcast.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the template." }, "type": { "type": "string", "description": "The type of template.", "enum": [ "email", "webhook", "push", "sms", "slack" ] } } } }, "broadcastTriggerObject": { "x-scalar-ignore": true, "type": "object", "description": "You can get triggers to know when you triggered a broadcast and whether or not it's been processed.", "properties": { "id": { "type": "integer", "description": "The identifier for a broadcast trigger." }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "created_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "processed_at": { "type": "integer", "format": "unix timestamp", "description": "The date-time when Customer.io processed the trigger." } } }, "broadcastObject": { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the broadcast.", "readOnly": true }, "type": { "type": "string", "description": "The type of broadcast.", "enum": [ "triggered_broadcast" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "type": "boolean", "description": "If true, the broadcast is active." }, "state": { "type": "string", "description": "The state of the broadcast.", "enum": [ "running", "draft" ] }, "actions": { "type": "array", "description": "A list of actions used by the broadcast.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the action." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "email", "webhook", "push", "sms", "slack" ] } } } }, "msg_template_ids": { "x-scalar-ignore": true, "type": "array", "deprecated": true, "description": "Indicates the message template(s) used in this broadcast.", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the template." }, "type": { "type": "string", "description": "The type of template.", "enum": [ "email", "webhook", "push", "sms", "slack" ] } } } }, "first_started": { "type": "integer", "format": "unix timestamp", "description": "The date and time when you activated the broadcast.", "example": 1552341937 }, "tags": { "type": "array", "description": "An array of tags you set on this broadcast.", "items": { "type": "string" } } }, "example": { "id": 2, "deduplicate_id": "2:1520467200", "created": 1520467200, "type": "triggered_broadcast", "updated": 1520467200, "name": "basic", "active": true, "state": "running", "actions": [ { "id": 3, "type": "email" }, { "id": 4 }, { "type": "webhook" } ], "tags": "nil", "first_started": 1520467200, "created_by": "ExamplePerson" } }, "sendpush": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "required": [ "transactional_message_id", "identifiers" ], "properties": { "transactional_message_id": { "description": "The transactional message template that you want to use for your message. You can call the template by its numerical ID or by the *Trigger Name* that you assigned to the template in the UI (case insensitive).", "oneOf": [ { "title": "ID (integer)", "type": "integer", "description": "The ID of the transactional message you want to send.", "example": 44 }, { "title": "Trigger Name (string)", "type": "string", "description": "The name of trigger for the transactional message you want to send; you set the trigger name in the *Configure Settings* step when setting up your message. This is case insensitive.", "example": "pwdreset" } ] }, "auto_create": { "type": "boolean", "default": false, "description": "If `true` and your `transactional_message_id` doesn't match a record, Customer.io creates an empty record using that value as the *Trigger Name*. The ID must be a string. If the name already belongs to another channel, the request fails with `400`, and numeric IDs ignore this setting. See [details](/journeys/transactional-email/#auto-create-transactional-message-records)." } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "to": { "type": "string", "description": "The devices you want to send this push to—`all`, `last_used`, or a custom device token from the identified profile. Defaults to `all` and overrides the `To` value from your transactional template.", "enum": [ "all", "last_used", "$device_token" ], "default": "all" }, "title": { "type": "string", "description": "The title for your notification. This overrides the title of the transactional template (referenced by `transactional_message_id`)." }, "message": { "type": "string", "description": "The message body for your notification. This overrides the notification body of the transactional template (referenced by `transactional_message_id`)." }, "image_url": { "type": "string", "description": "An image URL to show in the push. This overrides Image from the transactional template (referenced by `transactional_message_id`)." }, "link": { "type": "string", "description": "A deep link to open when the push is tapped. This overrides Link from the transactional template (referenced by `transactional_message_id`)." }, "sound": { "type": "string", "description": "**For iOS Only**: your notification can alert users with the device's default notification sound or play no sound at all.\n", "enum": [ "default", "none" ], "default": "default" }, "custom_data": { "type": "object", "description": "Optional key/value pairs you want to attach to the push payload. Firebase only supports string values. This overrides the Custom Data from your transactional template." }, "custom_device": { "description": "A device to perform an upsert operation at the time of send. The device will be added/updated on the profile from the Identifiers block.", "allOf": [ { "type": "object", "required": [ "token" ], "properties": { "token": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] }, "custom_payload": { "type": "object", "description": "Optional key/value pairs you want to attach to the push payload. Firebase only supports string values. This overrides all other payload values, including the Custom Payload from your transactional template.", "properties": { "ios": { "x-scalar-ignore": true, "description": "Your payload changes depending on whether you send to iOS devices through Google's Firebase Cloud Messaging (FCM) or Apple's Push Notification service (APNs).", "oneOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The base object for all FCM payloads.", "required": [ "apns" ], "properties": { "apns": { "type": "object", "required": [ "payload" ], "description": "Defines a payload for iOS devices sent through Firebase Cloud Messaging (FCM).", "properties": { "headers": { "description": "Headers defined by [Apple's payload reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) that you want to pass through FCM.", "type": "object" }, "payload": { "type": "object", "description": "Contains a push payload.", "properties": { "CIO": { "type": "object", "description": "Contains properties interpreted by the Customer.io iOS SDK.", "required": [ "push" ], "properties": { "push": { "type": "object", "description": "A push payload for the iOS SDK.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } }, "additionalProperties": { "description": "Additional properties that you've set up your app to interpret outside of the Customer.io SDK.", "x-additionalPropertiesName": "Custom key-value pairs" } } } } } } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "CIO": { "type": "object", "required": [ "push" ], "description": "Contains options supported by the Customer.io SDK.", "properties": { "push": { "type": "object", "description": "Describes push notification options supported by the CIO SDK.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } } } ] }, "android": { "x-scalar-ignore": true, "type": "object", "description": "A custom push payload for Android devices.", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The parent object for Android custom push payloads.", "properties": { "notification": { "type": "object", "description": "Contains the push body and title.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." } } }, "data": { "type": "object", "description": "Contains key-value pairs that your app interprets.", "additionalProperties": { "x-additionalPropertiesName": "Attachment Names", "x-doNotRender": true, "type": "string" } }, "android": { "type": "object", "description": "Contains custom push options for your notification.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } } } } } }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/journeys/channels/localization/getting-started/#supported-languages)." } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": 12345 } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "cool.person@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in your message.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" } }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "disable_message_retention": { "x-scalar-ignore": true, "type": "boolean", "default": false, "description": "If true, the message body is not retained in delivery history. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "send_to_unsubscribed": { "x-scalar-ignore": true, "type": "boolean", "default": true, "description": "If false, your message is not sent to unsubscribed recipients. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false } } } ], "example": { "transactional_message_id": 44, "title": "Did you really login from a new location?", "identifiers": { "id": 12345 }, "message_data": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" } } }, "sendinbox": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "required": [ "transactional_message_id", "identifiers" ], "properties": { "transactional_message_id": { "description": "The transactional message template that you want to use for your message. You can call the template by its numerical ID or by the *Trigger Name* that you assigned to the template in the UI (case insensitive).", "oneOf": [ { "title": "ID (integer)", "type": "integer", "description": "The ID of the transactional message you want to send.", "example": 44 }, { "title": "Trigger Name (string)", "type": "string", "description": "The name of trigger for the transactional message you want to send; you set the trigger name in the *Configure Settings* step when setting up your message. This is case insensitive.", "example": "order_shipped" } ] }, "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": "user_123" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "user@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in the format `{{trigger.}}` in your inbox message. These values will populate the `properties` field in the message received by your application.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "order_id": "ORD-5678", "tracking_url": "https://track.example.com/5678" } }, "to": { "type": "string", "description": "Optional override for the recipient. This is typically not needed as the message is sent to the person identified by `identifiers`." }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/journeys/channels/localization/getting-started/#supported-languages)." }, "auto_create": { "type": "boolean", "default": false, "description": "Accepted for inbox sends, but of limited use. An auto-created record has no content or layout until you populate it in the UI, so we recommend [creating the inbox message in the UI](/journeys/channels/in-app/inbox/send-inbox-txnl/) instead. Your `transactional_message_id` must be a new string." } } } ], "example": { "transactional_message_id": "order_shipped", "identifiers": { "id": "user_123" }, "message_data": { "order_id": "ORD-5678", "tracking_url": "https://track.example.com/5678", "product_name": "Blue Widget", "product_image": "https://cdn.example.com/widget.jpg" } } }, "sendinapp": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "required": [ "transactional_message_id", "identifiers" ], "properties": { "transactional_message_id": { "description": "The transactional message template that you want to use for your message. You can call the template by its numerical ID or by the *Trigger Name* that you assigned to the template in the UI (case insensitive).", "oneOf": [ { "title": "ID (integer)", "type": "integer", "description": "The ID of the transactional message you want to send.", "example": 44 }, { "title": "Trigger Name (string)", "type": "string", "description": "The name of trigger for the transactional message you want to send; you set the trigger name in the *Configure Settings* step when setting up your message. This is case insensitive.", "example": "order_confirmation" } ] }, "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": "user_123" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "user@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in the format `{{trigger.}}` in your in-app message. These values populate the `properties` field in the message that the SDK delivers to your application.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "order_id": "ORD-5678", "tracking_url": "https://track.example.com/5678" } }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/journeys/channels/localization/getting-started/#supported-languages)." }, "auto_create": { "type": "boolean", "default": false, "description": "Accepted for in-app sends, but of limited use. An auto-created record has no content or layout until you populate it in the UI, so we recommend [creating the in-app message in the UI](/journeys/send/transactional/in-app/) instead. Your `transactional_message_id` must be a new string." } } } ], "example": { "transactional_message_id": "order_confirmation", "identifiers": { "id": "user_123" }, "message_data": { "order_id": "ORD-5678", "tracking_url": "https://track.example.com/5678" } } }, "sendemail": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "required": [ "to" ], "properties": { "transactional_message_id": { "description": "The transactional message template you want to use. You can call the template by its numerical ID or by the *Trigger Name* that you assigned to the template in the UI (case insensitive).", "oneOf": [ { "title": "ID (integer)", "type": "integer", "description": "The ID of the transactional message you want to send.", "example": 44 }, { "title": "Trigger Name (string)", "type": "string", "description": "The name of trigger for the transactional message you want to send. You set the trigger name in the **Configure Settings** step in the UI when setting up your message. This is case insensitive.", "example": "pwdreset" } ] }, "body": { "type": "string", "description": "The HTML body of your message. If you provide a `transactional_message_id`, this overrides the template's body. It's also the fallback when you send AMP email (`body_amp`) to a client that doesn't support AMP.", "example": "Your temporary password is {{message_data.password_reset_token}}" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." }, "body_plain": { "type": "string", "description": "The plaintext body of your message. If you provide `transactional_message_id`, this overrides the template's plaintext body." }, "subject": { "type": "string", "description": "The subject line for your message. If you provide `transactional_message_id`, this overrides the template's subject.", "example": "Reset your password!" }, "from": { "type": "string", "description": "The address your email is from. It must be a [verified sender](/journeys/channels/email/deliverability/authentication/). Quote any display name, like `\\\"Person\\\" `. This overrides the template's sender; omit it to use the template or your workspace default.", "example": "support@example.com" }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/journeys/channels/localization/getting-started/#supported-languages)." }, "auto_create": { "type": "boolean", "default": false, "description": "If `true` and your `transactional_message_id` doesn't match a record, Customer.io creates an empty record using that value as the *Trigger Name*. The ID must be a string. If the name already belongs to another channel, the request fails with `400`, and numeric IDs ignore this setting. See [details](/journeys/transactional-email/#auto-create-transactional-message-records)." } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": 12345 } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "cool.person@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in your message.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" } }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "disable_message_retention": { "x-scalar-ignore": true, "type": "boolean", "default": false, "description": "If true, the message body is not retained in delivery history. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "send_to_unsubscribed": { "x-scalar-ignore": true, "type": "boolean", "default": true, "description": "If false, your message is not sent to unsubscribed recipients. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "to": { "type": "string", "description": "The recipients you want to send to, separated by commas. You can include up to 15 total recipients across `to`, `cc`, and `bcc`, with optional display names in quotes.", "example": "cool.person@example.com" }, "cc": { "type": "string", "description": "Carbon copy message recipients, separated by commas. Unlike BCC recipients, CC recipients are visible to everyone who receives the message. Their opens, clicks, and bounces count toward your message metrics. CC recipients count toward the limit of 15 total recipients across the `to`, `cc`, and `bcc` keys.", "example": "cc@example.com" }, "bcc": { "type": "string", "description": "Blind copy message recipients. Supports multiple addresses separated by commas. Your request can contain up to 15 total recipients between the `to`, `cc`, and `bcc` keys.", "example": "bcc@example.com" }, "fake_bcc": { "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "reply_to": { "type": "string", "description": "The address that recipients can reply to, if different from the `from` address.", "example": "replyto@example.com" }, "preheader": { "x-scalar-ignore": true, "type": "string", "description": "Also known as \"preview text\", this is the block block of text that users see next to, or underneath, the subject line in their inbox." }, "attachments": { "x-scalar-ignore": true, "type": "object", "description": "A dictionary of attachments where the filename is the key and the value is the base64-encoded contents. The filename must include the extension (i.e. `name.csv`). The total size of all attachments must be less than 2 MB.", "properties": { "": { "type": "string", "format": "base64" } } }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "disable_css_preprocessing": { "type": "boolean", "description": "Set to `true` to disable CSS preprocessing. This setting overrides the CSS preprocessing setting on the `transactional_message_id` as set in the user interface. Transactional emails have CSS preprocessing enabled by default.", "example": false, "default": false }, "tracked": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, Customer.io tracks opens and link clicks in your message.", "default": true } } } ], "example": { "transactional_message_id": 44, "to": "cool.person@example.com", "from": "override-templated-address@example.com", "subject": "Order receipt", "identifiers": { "email": "cool.person@example.com" }, "message_data": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" }, "attachments": { "file1.csv": "base64encodedcontent", "file2.pdf": "base64encodedcontent" }, "headers": { "X-Mailgun-Tag": "my-cool-tag" }, "bcc": "bcc@example.com", "disable_message_retention": false, "send_to_unsubscribed": true, "tracked": true, "queue_draft": false, "disable_css_preprocessing": true } }, "sendsms": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "required": [ "transactional_message_id", "identifiers" ], "properties": { "transactional_message_id": { "description": "The transactional message template that you want to use for your message. You can call the template by its numerical ID or by the *Trigger Name* that you assigned to the template in the UI (case insensitive).", "oneOf": [ { "title": "ID (integer)", "type": "integer", "description": "The ID of the transactional message you want to send.", "example": 44 }, { "title": "Trigger Name (string)", "type": "string", "description": "The name of trigger for the transactional message you want to send; you set the trigger name in the *Configure Settings* step when setting up your message. This is case insensitive.", "example": "verification_code" } ] } } }, { "type": "object", "required": [ "to" ], "properties": { "to": { "type": "string", "description": "The phone number you want to send your SMS to. Use E.164 format, like `+15551234567`, or Liquid if you store phone numbers as attributes.", "example": "{{customer.phone}}" }, "from": { "type": "string", "description": "The phone number or sender ID your SMS is from. It must be verified in your Twilio account. This overrides the template's sender. Use E.164 format for a phone number.", "example": "+15551234567" }, "tracked": { "type": "boolean", "default": true, "description": "Whether to track link clicks for this SMS. Defaults to the transactional message's own tracking setting." }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/journeys/channels/localization/getting-started/#supported-languages)." }, "auto_create": { "type": "boolean", "default": false, "description": "If `true` and your `transactional_message_id` doesn't match a record, Customer.io creates an empty record using that value as the *Trigger Name*. The ID must be a string. If the name already belongs to another channel, the request fails with `400`, and numeric IDs ignore this setting. See [details](/journeys/transactional-email/#auto-create-transactional-message-records)." } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": 12345 } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "cool.person@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in your message.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" } }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "disable_message_retention": { "x-scalar-ignore": true, "type": "boolean", "default": false, "description": "If true, the message body is not retained in delivery history. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "send_to_unsubscribed": { "x-scalar-ignore": true, "type": "boolean", "default": true, "description": "If false, your message is not sent to unsubscribed recipients. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false } } } ], "example": { "transactional_message_id": "confirmation code", "to": "+15559876543", "from": "+15551234567", "identifiers": { "id": "123456" }, "message_data": { "confirmation_code": "123456", "account_name": "Jane Doe" } } }, "sendwhatsapp": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "required": [ "transactional_message_id", "identifiers" ], "properties": { "transactional_message_id": { "description": "The transactional message template that you want to use for your message. You can call the template by its numerical ID or by the *Trigger Name* that you assigned to the template in the UI (case insensitive).", "oneOf": [ { "title": "ID (integer)", "type": "integer", "description": "The ID of the transactional message you want to send.", "example": 44 }, { "title": "Trigger Name (string)", "type": "string", "description": "The name of trigger for the transactional message you want to send; you set the trigger name in the *Configure Settings* step when setting up your message. This is case insensitive.", "example": "verification_code" } ] } } }, { "type": "object", "required": [ "to" ], "properties": { "to": { "type": "string", "description": "The WhatsApp phone number you want to send your message to. Use E.164 format, like `+15551234567`, or Liquid if you store phone numbers as attributes. The recipient must be able to receive WhatsApp messages.", "example": "{{customer.phone}}" }, "from": { "type": "string", "description": "The WhatsApp-approved sender (phone number or sender ID) that your message is from. It must be a WhatsApp-approved sender configured in your workspace. This overrides the template's sender. Use E.164 format for a phone number.", "example": "+15551234567" }, "tracked": { "type": "boolean", "default": true, "description": "Whether to track link clicks for this WhatsApp message. Defaults to the transactional message's own tracking setting." }, "language": { "type": "string", "description": "Overrides language preferences for the person you want to send your transactional message to. Use one of our [supported two- or four-letter language codes](/messaging/channels/localization/getting-started/#supported-languages)." } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "Identifies the person represented by your transactional message by one of, and only one of, `id`, `email`, or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "The identifier for the person represented by the transactional message. **NOTE**: If your workspace identifies people by email, use the `email` identifier instead.\n", "example": 12345 } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The identifier for the person represented by the transactional message. Use this option if your workspace identifies people by email rather than by `id`.", "example": "cool.person@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "type": "string", "description": "A unique, immutable identifier for a person, set by Customer.io when you add a person.", "example": 3000001 } } } ] }, "message_data": { "type": "object", "description": "An object containing the key-value pairs referenced using liquid in your message.", "additionalProperties": { "x-additionalPropertiesName": "Liquid Data", "description": "Insert key-values that you want to reference in your message here." }, "example": { "password_reset_token": "abcde-12345-fghij-d888", "account_id": "123dj" } }, "send_at": { "type": "integer", "description": "A unix timestamp (seconds since epoch) determining when the message will be sent. The timestamp can be up to 90 days in the future. If this value is in the past, your message is sent immediately." }, "disable_message_retention": { "x-scalar-ignore": true, "type": "boolean", "default": false, "description": "If true, the message body is not retained in delivery history. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "send_to_unsubscribed": { "x-scalar-ignore": true, "type": "boolean", "default": true, "description": "If false, your message is not sent to unsubscribed recipients. Setting this value overrides the value set in the settings of your `transactional_message_id`." }, "queue_draft": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, your transactional message is held as a draft in Customer.io and not sent directly to your audience. You must go to the Deliveries and Drafts page to send your message.", "default": false } } } ], "example": { "transactional_message_id": "confirmation code", "to": "+15559876543", "from": "+15551234567", "identifiers": { "id": "123456" }, "message_data": { "confirmation_code": "123456", "account_name": "Jane Doe" } } }, "transactionalObject": { "x-scalar-ignore": true, "description": "Contains information about a transactional message.", "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier Customer.io assigned to the transactional message", "example": 2 }, "name": { "type": "string", "description": "The name you set for the transactional message.", "example": "password reset" }, "description": { "type": "string", "description": "A description of the transactional message.", "example": "sends a temporary password and lets the customer reset their password." }, "send_to_unsubscribed": { "type": "boolean", "description": "If true, people with an `unsubscribed` attribute set to `true` can trigger the message." }, "link_tracking": { "type": "boolean", "description": "If true, link tracking is enabled for this message." }, "open_tracking": { "type": "boolean", "description": "If true, open-tracking is enabled for this message." }, "hide_message_body": { "type": "boolean", "description": "If true, message contents are not retained in delivery history—you cannot recall the exact contents of the message." }, "queue_drafts": { "type": "boolean", "description": "If true, messages do not send automatically, and queue as drafts instead. You must send drafts through the *Deliveries & Drafts* page in the user interface." }, "created_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated_at": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true } } }, "updateContentRequest": { "oneOf": [ { "title": "Email", "description": "Update the contents of an email newsletter variant. You can set the sender with `from_id`. If you don't provide it, the existing sender is preserved.\n", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email" ], "readOnly": true }, "body": { "type": "string", "description": "The HTML body of the email. You cannot modify the body if you created the newsletter with Design Studio or the drag-and-drop editor." }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." }, "body_plain": { "x-scalar-ignore": true, "type": "string", "description": "By default, your workspace generates a plaintext version of your message body for each delivery. Use this key to override the default plain text body." }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "recipient": { "type": "string", "description": "The recipient address for the newsletter. By default, it's `{{customer.email}}`." } } } ] }, { "title": "SMS", "description": "Update the contents of an SMS newsletter variant.", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "twilio" ], "readOnly": true }, "body": { "type": "string", "description": "The body of the SMS message.", "example": "Hi {{ customer.first_name }}, check out our latest deals!" } } } ] }, { "title": "Push", "description": "Update the contents of a push notification newsletter variant.", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "push" ], "readOnly": true }, "subject": { "type": "string", "description": "The title of the push notification.", "example": "24-hour flash sale!" }, "body": { "type": "string", "description": "The body of the push notification.", "example": "Get 30% off everything. Tap to shop now." } } } ] }, { "title": "Webhook", "description": "Update the contents of a webhook newsletter variant.", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook" ], "readOnly": true }, "body": { "type": "string", "description": "The body content of the webhook request.", "example": "{\"channel\":\"#marketing\",\"text\":\"Newsletter sent to {{ customer.email }}\"}" }, "headers": { "x-scalar-ignore": true, "description": "Headers you want to add or update. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "value": { "type": "string", "description": "The value of the header." } }, "example": [ { "name": "X-Mailgun-Tag", "value": "my-cool-tag" } ] } } } } ] }, { "title": "In-App", "description": "You can't update in-app message content through the API—you can only set it when you [create the message](/integrations/api/app/tag/newsletters/createNewsletter/). Use the message editor to update the content of your message.\n", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "in_app" ], "readOnly": true } } } ] }, { "title": "Inbox message", "description": "You can't update inbox message content through the API—you can only set it when you [create the message](/integrations/api/app/tag/newsletters/createNewsletter/). Use the message editor to update the content of your inbox message.\n", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "inbox" ], "readOnly": true } } } ] } ], "discriminator": { "propertyName": "type" } }, "updateContentCommon": { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, "updateEmailContent": { "title": "Email", "description": "Update the contents of an email newsletter variant. You can set the sender with `from_id`. If you don't provide it, the existing sender is preserved.\n", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email" ], "readOnly": true }, "body": { "type": "string", "description": "The HTML body of the email. You cannot modify the body if you created the newsletter with Design Studio or the drag-and-drop editor." }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." }, "body_plain": { "x-scalar-ignore": true, "type": "string", "description": "By default, your workspace generates a plaintext version of your message body for each delivery. Use this key to override the default plain text body." }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "recipient": { "type": "string", "description": "The recipient address for the newsletter. By default, it's `{{customer.email}}`." } } } ] }, "updateSmsContent": { "title": "SMS", "description": "Update the contents of an SMS newsletter variant.", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "twilio" ], "readOnly": true }, "body": { "type": "string", "description": "The body of the SMS message.", "example": "Hi {{ customer.first_name }}, check out our latest deals!" } } } ] }, "updatePushContent": { "title": "Push", "description": "Update the contents of a push notification newsletter variant.", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "push" ], "readOnly": true }, "subject": { "type": "string", "description": "The title of the push notification.", "example": "24-hour flash sale!" }, "body": { "type": "string", "description": "The body of the push notification.", "example": "Get 30% off everything. Tap to shop now." } } } ] }, "updateInAppContent": { "title": "In-App", "description": "You can't update in-app message content through the API—you can only set it when you [create the message](/integrations/api/app/tag/newsletters/createNewsletter/). Use the message editor to update the content of your message.\n", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "in_app" ], "readOnly": true } } } ] }, "updateInboxContent": { "title": "Inbox message", "description": "You can't update inbox message content through the API—you can only set it when you [create the message](/integrations/api/app/tag/newsletters/createNewsletter/). Use the message editor to update the content of your inbox message.\n", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "inbox" ], "readOnly": true } } } ] }, "updateWebhookContent": { "title": "Webhook", "description": "Update the contents of a webhook newsletter variant.", "allOf": [ { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "webhook" ], "readOnly": true }, "body": { "type": "string", "description": "The body content of the webhook request.", "example": "{\"channel\":\"#marketing\",\"text\":\"Newsletter sent to {{ customer.email }}\"}" }, "headers": { "x-scalar-ignore": true, "description": "Headers you want to add or update. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "value": { "type": "string", "description": "The value of the header." } }, "example": [ { "name": "X-Mailgun-Tag", "value": "my-cool-tag" } ] } } } } ] }, "getContentObject": { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of a newsletter variant—a language in a multi-language newsletter or a test in an A/B test.", "readOnly": true }, "newsletter_id": { "x-scalar-ignore": true, "description": "The identifier for a newsletter.", "type": "integer", "example": 10 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the variant, if it exists.", "readOnly": true, "example": "newsletter variant A" }, "layout": { "type": "string", "description": "The layout used for the variant, if it exists.", "example": "{{ content }}", "readOnly": true }, "body": { "type": "string", "description": "The body of the variant. You cannot modify the body if you created it with our drag-and-drop editor.", "example": "Hello from the API" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" } } }, { "type": "object", "properties": { "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" } } } ] }, "contentObject": { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of a newsletter variant—a language in a multi-language newsletter or a test in an A/B test.", "readOnly": true }, "newsletter_id": { "x-scalar-ignore": true, "description": "The identifier for a newsletter.", "type": "integer", "example": 10 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the variant, if it exists.", "readOnly": true, "example": "newsletter variant A" }, "layout": { "type": "string", "description": "The layout used for the variant, if it exists.", "example": "{{ content }}", "readOnly": true }, "body": { "type": "string", "description": "The body of the variant. You cannot modify the body if you created it with our drag-and-drop editor.", "example": "Hello from the API" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" } } }, "action_id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "message_id": { "x-scalar-ignore": true, "description": "The identifier for a delivery—the instance of a message intended for an individual recipient.", "type": "string", "readOnly": true, "example": "dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=" }, "message_template_id": { "x-scalar-ignore": true, "description": "The identifier of the message template used to create a message.", "type": "integer", "readOnly": true, "deprecated": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "recipient_not_templated": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "test@example.com" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "newsletter_id": { "x-scalar-ignore": true, "description": "The identifier for a newsletter.", "type": "integer", "example": 10 }, "content_id": { "x-scalar-ignore": true, "description": "The identifier for a message in a newsletter. Newsletters can have multiple content IDs (for multi-language messages or A/B tests).", "type": "integer", "readOnly": true, "example": 1 }, "newsletterMessageType": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" }, "messageType": { "x-scalar-ignore": true, "description": "The type of message or action for a delivery, automation action, or related object. Includes channels that newsletters do not support (for example, `slack` and `whatsapp`).", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "slack", "whatsapp", "live_notification" ], "readOnly": true, "example": "email" }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_settable": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "example": "replyto@example.com" }, "from_address": { "x-scalar-ignore": true, "type": "string", "format": "email", "description": "The address you want to trigger messages from, overriding the `from` field in emails triggered by the event." }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "trigger_event_id": { "x-scalar-ignore": true, "type": "string", "description": "The id of the event that triggered an event-triggered automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "messageObjectBase": { "x-scalar-ignore": true, "type": "object", "description": "Describes an individual message delivery. The object contains keys for all possible parents of the message (`newsletter_id`, `broadcast_id`, etc) but only the parents of the delivery are populated. Other parent IDs are null.", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for a delivery—the instance of a message intended for an individual recipient.", "type": "string", "readOnly": true, "example": "dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "message_template_id": { "x-scalar-ignore": true, "description": "The identifier of the message template used to create a message.", "type": "integer", "readOnly": true, "deprecated": true }, "customer_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" }, "customer_identifiers": { "x-scalar-ignore": true, "type": "object", "description": "Identifiers for the person in a response—`id`, `cio_id`, and `email`. Unset `id` or `email` values are `null`. We recommend this object over the less descriptive `customer_id`. This object doesn't include `phone`, even if your workspace uses phone numbers as an identifier; look for the person's `phone` attribute instead.", "required": [ "email", "id", "cio_id" ], "properties": { "email": { "type": [ "string", "null" ], "format": "email", "description": "A person's email address, if set.", "example": "test@example.com" }, "id": { "type": [ "string", "null" ], "description": "A person's unique ID, if set. This is the same as the `customer_id` if present.", "example": 2 }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "metrics": { "x-scalar-ignore": true, "type": "object", "description": "Metrics for an individual instance of a message; each item in the object represents the timestamp when a message achieved a particular metric. This object only contains metrics that have been recorded.", "properties": { "bounced": { "type": "integer", "description": "The timestamp when the message `bounced`." }, "clicked": { "type": "integer", "description": "The timestamp when the message was `clicked`." }, "human_clicked": { "type": "integer", "description": "The number of `clicked` messages excluding machine clicks. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_clicked": { "type": "integer", "description": "The number of `clicked` messages attributed to machines. This metric is reliable starting April 20, 2025." }, "converted": { "type": "integer", "description": "The timestamp when the message was `converted`." }, "created": { "type": "integer", "description": "The timestamp when the message was `created`." }, "delivered": { "type": "integer", "description": "The timestamp when the message was `delivered`." }, "drafted": { "type": "integer", "description": "The timestamp when the message was `drafted`." }, "dropped": { "type": "integer", "description": "The timestamp when the message was `dropped`." }, "failed": { "type": "integer", "description": "The timestamp when the message `failed`." }, "opened": { "type": "integer", "description": "The timestamp when the message was `opened`." }, "human_opened": { "type": "integer", "description": "The number of `opened` messages excluding machine opens. This metric is reliable starting March 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_opened": { "type": "integer", "description": "The number of `opened` messages attributed to machines. This metric is reliable starting March 20, 2025." }, "sent": { "type": "integer", "description": "The timestamp when the message was `sent`." }, "spammed": { "type": "integer", "description": "The timestamp when the message was marked as spam." }, "undeliverable": { "type": "integer", "description": "The timestamp when the message became `undeliverable`." }, "unsubscribed": { "type": "integer", "description": "The timestamp when a person unsubscribed based on this message." } } }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "failure_message": { "type": [ "string", "null" ], "description": "Explains why a message failed, if applicable." }, "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, { "type": "null" } ] }, "action_id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "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 message in a newsletter. Newsletters can have multiple content IDs (for multi-language messages or A/B tests).", "type": "integer", "readOnly": true, "example": 1 }, "broadcast_id": { "oneOf": [ { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, { "type": "null" } ] }, "trigger_event_id": { "x-scalar-ignore": true, "type": "string", "description": "The id of the event that triggered an event-triggered automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "forgotten": { "type": "boolean", "description": "If true message contents are not retained by Customer.io." }, "tracked_responses": { "type": "object", "description": "Tracked in-app survey responses, keyed by response option name. Present only when `get_tracked_responses` is `true`.", "additionalProperties": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the tracked response." }, "ts": { "type": "integer", "description": "A unix timestamp representing when the response was tracked." } } }, "example": { "cool-button": { "id": 1, "ts": 1715769600 }, "cool-button-2": { "id": 2, "ts": 1715769600 } } } } }, "messageObject": { "x-scalar-ignore": true, "description": "Describes an individual message delivery. The object contains keys for all possible parents of the message (`newsletter_id`, `broadcast_id`, etc) but only the parents of the delivery are populated. Other parent IDs are null.", "allOf": [ { "x-scalar-ignore": true, "type": "object", "description": "Describes an individual message delivery. The object contains keys for all possible parents of the message (`newsletter_id`, `broadcast_id`, etc) but only the parents of the delivery are populated. Other parent IDs are null.", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for a delivery—the instance of a message intended for an individual recipient.", "type": "string", "readOnly": true, "example": "dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "message_template_id": { "x-scalar-ignore": true, "description": "The identifier of the message template used to create a message.", "type": "integer", "readOnly": true, "deprecated": true }, "customer_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" }, "customer_identifiers": { "x-scalar-ignore": true, "type": "object", "description": "Identifiers for the person in a response—`id`, `cio_id`, and `email`. Unset `id` or `email` values are `null`. We recommend this object over the less descriptive `customer_id`. This object doesn't include `phone`, even if your workspace uses phone numbers as an identifier; look for the person's `phone` attribute instead.", "required": [ "email", "id", "cio_id" ], "properties": { "email": { "type": [ "string", "null" ], "format": "email", "description": "A person's email address, if set.", "example": "test@example.com" }, "id": { "type": [ "string", "null" ], "description": "A person's unique ID, if set. This is the same as the `customer_id` if present.", "example": 2 }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "metrics": { "x-scalar-ignore": true, "type": "object", "description": "Metrics for an individual instance of a message; each item in the object represents the timestamp when a message achieved a particular metric. This object only contains metrics that have been recorded.", "properties": { "bounced": { "type": "integer", "description": "The timestamp when the message `bounced`." }, "clicked": { "type": "integer", "description": "The timestamp when the message was `clicked`." }, "human_clicked": { "type": "integer", "description": "The number of `clicked` messages excluding machine clicks. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_clicked": { "type": "integer", "description": "The number of `clicked` messages attributed to machines. This metric is reliable starting April 20, 2025." }, "converted": { "type": "integer", "description": "The timestamp when the message was `converted`." }, "created": { "type": "integer", "description": "The timestamp when the message was `created`." }, "delivered": { "type": "integer", "description": "The timestamp when the message was `delivered`." }, "drafted": { "type": "integer", "description": "The timestamp when the message was `drafted`." }, "dropped": { "type": "integer", "description": "The timestamp when the message was `dropped`." }, "failed": { "type": "integer", "description": "The timestamp when the message `failed`." }, "opened": { "type": "integer", "description": "The timestamp when the message was `opened`." }, "human_opened": { "type": "integer", "description": "The number of `opened` messages excluding machine opens. This metric is reliable starting March 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_opened": { "type": "integer", "description": "The number of `opened` messages attributed to machines. This metric is reliable starting March 20, 2025." }, "sent": { "type": "integer", "description": "The timestamp when the message was `sent`." }, "spammed": { "type": "integer", "description": "The timestamp when the message was marked as spam." }, "undeliverable": { "type": "integer", "description": "The timestamp when the message became `undeliverable`." }, "unsubscribed": { "type": "integer", "description": "The timestamp when a person unsubscribed based on this message." } } }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "failure_message": { "type": [ "string", "null" ], "description": "Explains why a message failed, if applicable." }, "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, { "type": "null" } ] }, "action_id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "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 message in a newsletter. Newsletters can have multiple content IDs (for multi-language messages or A/B tests).", "type": "integer", "readOnly": true, "example": 1 }, "broadcast_id": { "oneOf": [ { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, { "type": "null" } ] }, "trigger_event_id": { "x-scalar-ignore": true, "type": "string", "description": "The id of the event that triggered an event-triggered automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "forgotten": { "type": "boolean", "description": "If true message contents are not retained by Customer.io." }, "tracked_responses": { "type": "object", "description": "Tracked in-app survey responses, keyed by response option name. Present only when `get_tracked_responses` is `true`.", "additionalProperties": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the tracked response." }, "ts": { "type": "integer", "description": "A unix timestamp representing when the response was tracked." } } }, "example": { "cool-button": { "id": 1, "ts": 1715769600 }, "cool-button-2": { "id": 2, "ts": 1715769600 } } } } }, { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "The type of message or action for a delivery, automation action, or related object. Includes channels that newsletters do not support (for example, `slack` and `whatsapp`).", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "slack", "whatsapp", "live_notification" ], "readOnly": true, "example": "email" } } } ], "example": { "id": "ag1q6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=", "deduplicate_id": "ag1q6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=:1619137768", "msg_template_id": 43, "action_id": 215, "parent_action_id": null, "customer_id": null, "recipient": "person@example.com", "subject": "Did you get that thing I sent you?", "metrics": { "delivered": 1619137768, "sent": 1619137768 }, "created": 1619137767, "failure_message": null, "newsletter_id": null, "content_id": null, "campaign_id": 23, "broadcast_id": null, "trigger_event_id": null, "type": "email", "forgotten": false } }, "newsletterMessageObject": { "x-scalar-ignore": true, "description": "Each object is a delivery of a newsletter.", "allOf": [ { "x-scalar-ignore": true, "type": "object", "description": "Describes an individual message delivery. The object contains keys for all possible parents of the message (`newsletter_id`, `broadcast_id`, etc) but only the parents of the delivery are populated. Other parent IDs are null.", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for a delivery—the instance of a message intended for an individual recipient.", "type": "string", "readOnly": true, "example": "dgOq6QWq6QUBAAF4_CGoeVX7mFkDbRFu7ek=" }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "message_template_id": { "x-scalar-ignore": true, "description": "The identifier of the message template used to create a message.", "type": "integer", "readOnly": true, "deprecated": true }, "customer_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" }, "customer_identifiers": { "x-scalar-ignore": true, "type": "object", "description": "Identifiers for the person in a response—`id`, `cio_id`, and `email`. Unset `id` or `email` values are `null`. We recommend this object over the less descriptive `customer_id`. This object doesn't include `phone`, even if your workspace uses phone numbers as an identifier; look for the person's `phone` attribute instead.", "required": [ "email", "id", "cio_id" ], "properties": { "email": { "type": [ "string", "null" ], "format": "email", "description": "A person's email address, if set.", "example": "test@example.com" }, "id": { "type": [ "string", "null" ], "description": "A person's unique ID, if set. This is the same as the `customer_id` if present.", "example": 2 }, "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "metrics": { "x-scalar-ignore": true, "type": "object", "description": "Metrics for an individual instance of a message; each item in the object represents the timestamp when a message achieved a particular metric. This object only contains metrics that have been recorded.", "properties": { "bounced": { "type": "integer", "description": "The timestamp when the message `bounced`." }, "clicked": { "type": "integer", "description": "The timestamp when the message was `clicked`." }, "human_clicked": { "type": "integer", "description": "The number of `clicked` messages excluding machine clicks. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_clicked": { "type": "integer", "description": "The number of `clicked` messages attributed to machines. This metric is reliable starting April 20, 2025." }, "converted": { "type": "integer", "description": "The timestamp when the message was `converted`." }, "created": { "type": "integer", "description": "The timestamp when the message was `created`." }, "delivered": { "type": "integer", "description": "The timestamp when the message was `delivered`." }, "drafted": { "type": "integer", "description": "The timestamp when the message was `drafted`." }, "dropped": { "type": "integer", "description": "The timestamp when the message was `dropped`." }, "failed": { "type": "integer", "description": "The timestamp when the message `failed`." }, "opened": { "type": "integer", "description": "The timestamp when the message was `opened`." }, "human_opened": { "type": "integer", "description": "The number of `opened` messages excluding machine opens. This metric is reliable starting March 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_opened": { "type": "integer", "description": "The number of `opened` messages attributed to machines. This metric is reliable starting March 20, 2025." }, "sent": { "type": "integer", "description": "The timestamp when the message was `sent`." }, "spammed": { "type": "integer", "description": "The timestamp when the message was marked as spam." }, "undeliverable": { "type": "integer", "description": "The timestamp when the message became `undeliverable`." }, "unsubscribed": { "type": "integer", "description": "The timestamp when a person unsubscribed based on this message." } } }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "failure_message": { "type": [ "string", "null" ], "description": "Explains why a message failed, if applicable." }, "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, { "type": "null" } ] }, "action_id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "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 message in a newsletter. Newsletters can have multiple content IDs (for multi-language messages or A/B tests).", "type": "integer", "readOnly": true, "example": 1 }, "broadcast_id": { "oneOf": [ { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, { "type": "null" } ] }, "trigger_event_id": { "x-scalar-ignore": true, "type": "string", "description": "The id of the event that triggered an event-triggered automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "forgotten": { "type": "boolean", "description": "If true message contents are not retained by Customer.io." }, "tracked_responses": { "type": "object", "description": "Tracked in-app survey responses, keyed by response option name. Present only when `get_tracked_responses` is `true`.", "additionalProperties": { "type": "object", "properties": { "id": { "type": "integer", "description": "The identifier for the tracked response." }, "ts": { "type": "integer", "description": "A unix timestamp representing when the response was tracked." } } }, "example": { "cool-button": { "id": 1, "ts": 1715769600 }, "cool-button-2": { "id": 2, "ts": 1715769600 } } } } }, { "type": "object", "properties": { "type": { "x-scalar-ignore": true, "description": "Channel type for a newsletter or newsletter content variant.", "type": "string", "enum": [ "email", "webhook", "twilio", "push", "in_app", "inbox" ], "readOnly": true, "example": "email" } } } ] }, "webhookActionObject": { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "webhook" ], "readOnly": true }, "url": { "type": "string", "description": "The URL to send a webhook to, applies to `webhook` type actions.", "example": "https://my.example.com/webhook" }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "method": { "description": "The HTTP method for your webhook.", "type": "string", "enum": [ "get", "post", "put", "delete", "patch" ], "example": "post" }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." } } }, "emailActionObject": { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "email", "in_app", "push", "twilio", "slack", "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, "updateBroadcastActionObject": { "x-scalar-ignore": true, "oneOf": [ { "title": "Email / message", "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "email", "in_app", "push", "twilio", "slack", "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, { "type": "object", "properties": { "headers": { "x-scalar-ignore": true, "description": "Headers you want to add or update. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "value": { "type": "string", "description": "The value of the header." } }, "example": [ { "name": "X-Mailgun-Tag", "value": "my-cool-tag" } ] } } } } ] }, { "title": "SMS / MMS", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of your SMS." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For SMS/MMS messages, the `type` is always `twilio`.", "enum": [ "twilio" ], "readOnly": true }, "image_url": { "type": "string", "description": "The URL of the image in your SMS (MMS) message." }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient, usually an attribute you reference with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" } } } ] }, { "title": "WhatsApp", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 } } }, { "x-scalar-ignore": true, "description": "The action object for WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio). Messages sent through Twilio still use the `twilio` type and are treated similarly to SMS messages.", "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Welcome Message" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "A JSON string containing WhatsApp template metadata from Meta and template parameters with Liquid variables. Use `GET /v1/environments/{environment_id}/whatsapp/templates` to list templates.", "example": "{\"body\":\"\",\"image_url\":\"\",\"whatsapp_message_template\":{\"id\":\"12345\",\"name\":\"welcome\",\"language\":\"en_US\",\"status\":\"APPROVED\",\"components\":[...]},\"template_parameters\":{\"name\":\"welcome\",\"components\":[{\"type\":\"BODY\",\"parameters\":[{\"type\":\"text\",\"text\":\"{{customer.name}}\",\"parameter_name\":\"name\"}]}]}}" }, "body_json": { "type": "string", "description": "For visual editor content (if applicable)." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio), the `type` is always `whatsapp`.", "enum": [ "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient's phone number in E.164 format, usually referenced with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" }, "sender_identity_id": { "type": "integer", "description": "The ID of the WhatsApp Business phone number to send from. This corresponds to\na phone number registered in your WhatsApp Business Account and synced via\n`GET /v1/environments/{environment_id}/whatsapp/sync`.\n" }, "send_to_unsubscribed": { "type": "boolean", "description": "Whether to send this message to unsubscribed customers." }, "tracked": { "type": "boolean", "description": "Whether links in template parameters should be tracked.", "default": false } } } ] }, { "title": "Webhook", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "webhook" ], "readOnly": true }, "url": { "type": "string", "description": "The URL to send a webhook to, applies to `webhook` type actions.", "example": "https://my.example.com/webhook" }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "method": { "description": "The HTTP method for your webhook.", "type": "string", "enum": [ "get", "post", "put", "delete", "patch" ], "example": "post" }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." } } } ] } ] }, "broadcastActionObject": { "x-scalar-ignore": true, "oneOf": [ { "title": "Email / message", "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "email", "in_app", "push", "twilio", "slack", "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" } } } ] }, { "title": "SMS / MMS", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of your SMS." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For SMS/MMS messages, the `type` is always `twilio`.", "enum": [ "twilio" ], "readOnly": true }, "image_url": { "type": "string", "description": "The URL of the image in your SMS (MMS) message." }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient, usually an attribute you reference with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" } } } ] }, { "title": "WhatsApp", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 } } }, { "x-scalar-ignore": true, "description": "The action object for WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio). Messages sent through Twilio still use the `twilio` type and are treated similarly to SMS messages.", "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Welcome Message" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "A JSON string containing WhatsApp template metadata from Meta and template parameters with Liquid variables. Use `GET /v1/environments/{environment_id}/whatsapp/templates` to list templates.", "example": "{\"body\":\"\",\"image_url\":\"\",\"whatsapp_message_template\":{\"id\":\"12345\",\"name\":\"welcome\",\"language\":\"en_US\",\"status\":\"APPROVED\",\"components\":[...]},\"template_parameters\":{\"name\":\"welcome\",\"components\":[{\"type\":\"BODY\",\"parameters\":[{\"type\":\"text\",\"text\":\"{{customer.name}}\",\"parameter_name\":\"name\"}]}]}}" }, "body_json": { "type": "string", "description": "For visual editor content (if applicable)." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio), the `type` is always `whatsapp`.", "enum": [ "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient's phone number in E.164 format, usually referenced with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" }, "sender_identity_id": { "type": "integer", "description": "The ID of the WhatsApp Business phone number to send from. This corresponds to\na phone number registered in your WhatsApp Business Account and synced via\n`GET /v1/environments/{environment_id}/whatsapp/sync`.\n" }, "send_to_unsubscribed": { "type": "boolean", "description": "Whether to send this message to unsubscribed customers." }, "tracked": { "type": "boolean", "description": "Whether links in template parameters should be tracked.", "default": false } } } ] }, { "title": "Webhook", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "webhook" ], "readOnly": true }, "url": { "type": "string", "description": "The URL to send a webhook to, applies to `webhook` type actions.", "example": "https://my.example.com/webhook" }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "method": { "description": "The HTTP method for your webhook.", "type": "string", "enum": [ "get", "post", "put", "delete", "patch" ], "example": "post" }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." } } } ] } ] }, "updateTransactionalActionObject": { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "name": { "type": "string", "description": "The name of the transactional message.", "readOnly": true, "example": "Receipt" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the transactional message. You cannot modify the body if you created it with our drag-and-drop editor." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "The type of message.", "enum": [ "email", "push" ], "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, { "type": "object", "properties": { "headers": { "x-scalar-ignore": true, "description": "Headers you want to add or update. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "value": { "type": "string", "description": "The value of the header." } }, "example": [ { "name": "X-Mailgun-Tag", "value": "my-cool-tag" } ] } } } } ] }, "getTransactionalActionObject": { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "name": { "type": "string", "description": "The name of the transactional message.", "readOnly": true, "example": "Receipt" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the transactional message. You cannot modify the body if you created it with our drag-and-drop editor." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "The type of message.", "enum": [ "email", "push" ], "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, { "type": "object", "properties": { "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" } } } ] }, "transactionalActionObject": { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "name": { "type": "string", "description": "The name of the transactional message.", "readOnly": true, "example": "Receipt" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the transactional message. You cannot modify the body if you created it with our drag-and-drop editor." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "The type of message.", "enum": [ "email", "push" ], "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "smsActionObject": { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of your SMS." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For SMS/MMS messages, the `type` is always `twilio`.", "enum": [ "twilio" ], "readOnly": true }, "image_url": { "type": "string", "description": "The URL of the image in your SMS (MMS) message." }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient, usually an attribute you reference with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" } } }, "whatsAppActionObject": { "x-scalar-ignore": true, "description": "The action object for WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio). Messages sent through Twilio still use the `twilio` type and are treated similarly to SMS messages.", "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Welcome Message" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "A JSON string containing WhatsApp template metadata from Meta and template parameters with Liquid variables. Use `GET /v1/environments/{environment_id}/whatsapp/templates` to list templates.", "example": "{\"body\":\"\",\"image_url\":\"\",\"whatsapp_message_template\":{\"id\":\"12345\",\"name\":\"welcome\",\"language\":\"en_US\",\"status\":\"APPROVED\",\"components\":[...]},\"template_parameters\":{\"name\":\"welcome\",\"components\":[{\"type\":\"BODY\",\"parameters\":[{\"type\":\"text\",\"text\":\"{{customer.name}}\",\"parameter_name\":\"name\"}]}]}}" }, "body_json": { "type": "string", "description": "For visual editor content (if applicable)." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio), the `type` is always `whatsapp`.", "enum": [ "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient's phone number in E.164 format, usually referenced with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" }, "sender_identity_id": { "type": "integer", "description": "The ID of the WhatsApp Business phone number to send from. This corresponds to\na phone number registered in your WhatsApp Business Account and synced via\n`GET /v1/environments/{environment_id}/whatsapp/sync`.\n" }, "send_to_unsubscribed": { "type": "boolean", "description": "Whether to send this message to unsubscribed customers." }, "tracked": { "type": "boolean", "description": "Whether links in template parameters should be tracked.", "default": false } } }, "updateActionObject": { "x-scalar-ignore": true, "oneOf": [ { "title": "Email / message", "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "email", "in_app", "push", "twilio", "slack", "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "headers": { "x-scalar-ignore": true, "description": "Headers you want to add or update. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the header." }, "value": { "type": "string", "description": "The value of the header." } }, "example": [ { "name": "X-Mailgun-Tag", "value": "my-cool-tag" } ] } } } } ] }, { "title": "SMS/MMS", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of your SMS." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For SMS/MMS messages, the `type` is always `twilio`.", "enum": [ "twilio" ], "readOnly": true }, "image_url": { "type": "string", "description": "The URL of the image in your SMS (MMS) message." }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient, usually an attribute you reference with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" } } } ] }, { "title": "WhatsApp", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true } } }, { "x-scalar-ignore": true, "description": "The action object for WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio). Messages sent through Twilio still use the `twilio` type and are treated similarly to SMS messages.", "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Welcome Message" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "A JSON string containing WhatsApp template metadata from Meta and template parameters with Liquid variables. Use `GET /v1/environments/{environment_id}/whatsapp/templates` to list templates.", "example": "{\"body\":\"\",\"image_url\":\"\",\"whatsapp_message_template\":{\"id\":\"12345\",\"name\":\"welcome\",\"language\":\"en_US\",\"status\":\"APPROVED\",\"components\":[...]},\"template_parameters\":{\"name\":\"welcome\",\"components\":[{\"type\":\"BODY\",\"parameters\":[{\"type\":\"text\",\"text\":\"{{customer.name}}\",\"parameter_name\":\"name\"}]}]}}" }, "body_json": { "type": "string", "description": "For visual editor content (if applicable)." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio), the `type` is always `whatsapp`.", "enum": [ "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient's phone number in E.164 format, usually referenced with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" }, "sender_identity_id": { "type": "integer", "description": "The ID of the WhatsApp Business phone number to send from. This corresponds to\na phone number registered in your WhatsApp Business Account and synced via\n`GET /v1/environments/{environment_id}/whatsapp/sync`.\n" }, "send_to_unsubscribed": { "type": "boolean", "description": "Whether to send this message to unsubscribed customers." }, "tracked": { "type": "boolean", "description": "Whether links in template parameters should be tracked.", "default": false } } } ] }, { "title": "Webhook", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "webhook" ], "readOnly": true }, "url": { "type": "string", "description": "The URL to send a webhook to, applies to `webhook` type actions.", "example": "https://my.example.com/webhook" }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "method": { "description": "The HTTP method for your webhook.", "type": "string", "enum": [ "get", "post", "put", "delete", "patch" ], "example": "post" }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." } } } ] } ] }, "actionObject": { "x-scalar-ignore": true, "oneOf": [ { "title": "Email / message", "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "broadcast_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier for a broadcast.", "example": 2 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "email", "in_app", "push", "twilio", "slack", "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "from": { "x-scalar-ignore": true, "type": "string", "description": "The address that the message is from, relevant if the action `type` is `email`.", "readOnly": true, "example": "sentFrom@example.com" }, "from_id": { "x-scalar-ignore": true, "type": "integer", "description": "The identifier of the `from` address, commonly known as the \"sender\". Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 1 }, "reply_to": { "x-scalar-ignore": true, "type": "string", "description": "The address that receives replies for the message, if applicable.", "readOnly": true, "example": "replyto@example.com" }, "reply_to_id": { "x-scalar-ignore": true, "type": [ "integer", "null" ], "description": "The identifier for the `reply_to` address, if applicable. Use [List sender identities](/integrations/api/app/tag/sender-identities/listSenders/) to find valid IDs.", "example": 38 }, "preprocessor": { "x-scalar-ignore": true, "type": "string", "description": "If CSS pre-processing is enabled, this key is populated with `premailer`. Note, Juice replaced Premailer as the pre-processor, but you will only see `premailer` as the value.", "enum": [ "premailer" ], "readOnly": true }, "recipient": { "x-scalar-ignore": true, "description": "The recipient address for an action.", "type": "string", "example": "{{customer.email}}" }, "subject": { "x-scalar-ignore": true, "type": "string", "description": "The subject line for an `email` action.", "example": "Did you get that thing I sent you?" }, "cc": { "x-scalar-ignore": true, "readOnly": true, "description": "The carbon-copy address(es) for this action.", "type": "string" }, "bcc": { "x-scalar-ignore": true, "readOnly": true, "description": "The blind-copy address(es) for this action.", "type": "string" }, "fake_bcc": { "x-scalar-ignore": true, "readOnly": true, "type": "boolean", "description": "If true, rather than sending true copies to BCC addresses, Customer.io sends a copy of the message with the subject line containing the recipient address(es).\n" }, "preheader_text": { "x-scalar-ignore": true, "type": "string", "description": "[Also known as \"preview text\"](/journeys/channels/email/headers/custom-preheader-text/), this is the small block of text shown in an email inbox next to or underneath the subject line.\n" }, "body_amp": { "x-scalar-ignore": true, "type": "string", "description": "AMP-enabled content for your email. If a recipient's email client doesn't support AMP, they receive your `body` content instead. Make sure you're [set up to send AMP](/journeys/channels/email/layouts/amp-for-email/) first." } } }, { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" } } } ] }, { "title": "SMS/MMS", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of your SMS." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For SMS/MMS messages, the `type` is always `twilio`.", "enum": [ "twilio" ], "readOnly": true }, "image_url": { "type": "string", "description": "The URL of the image in your SMS (MMS) message." }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient, usually an attribute you reference with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" } } } ] }, { "title": "WhatsApp", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true } } }, { "x-scalar-ignore": true, "description": "The action object for WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio). Messages sent through Twilio still use the `twilio` type and are treated similarly to SMS messages.", "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action.", "readOnly": true, "example": "Welcome Message" }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "A JSON string containing WhatsApp template metadata from Meta and template parameters with Liquid variables. Use `GET /v1/environments/{environment_id}/whatsapp/templates` to list templates.", "example": "{\"body\":\"\",\"image_url\":\"\",\"whatsapp_message_template\":{\"id\":\"12345\",\"name\":\"welcome\",\"language\":\"en_US\",\"status\":\"APPROVED\",\"components\":[...]},\"template_parameters\":{\"name\":\"welcome\",\"components\":[{\"type\":\"BODY\",\"parameters\":[{\"type\":\"text\",\"text\":\"{{customer.name}}\",\"parameter_name\":\"name\"}]}]}}" }, "body_json": { "type": "string", "description": "For visual editor content (if applicable)." }, "language": { "x-scalar-ignore": true, "type": "string", "description": "The language variant for your message. If you don't use our [localization feature](/journeys/channels/localization/getting-started), or this is the default message, this value is an empty string.", "example": "fr", "readOnly": true }, "type": { "type": "string", "description": "For WhatsApp messages sent from Customer.io using your Facebook Business Account (not Twilio), the `type` is always `whatsapp`.", "enum": [ "whatsapp" ], "readOnly": true }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "recipient": { "type": "string", "description": "The recipient's phone number in E.164 format, usually referenced with Liquid like `{{customer.phone}}`. If you use Liquid, this field is blank in `GET` responses because we resolve the recipient at send time.", "example": "" }, "sender_identity_id": { "type": "integer", "description": "The ID of the WhatsApp Business phone number to send from. This corresponds to\na phone number registered in your WhatsApp Business Account and synced via\n`GET /v1/environments/{environment_id}/whatsapp/sync`.\n" }, "send_to_unsubscribed": { "type": "boolean", "description": "Whether to send this message to unsubscribed customers." }, "tracked": { "type": "boolean", "description": "Whether links in template parameters should be tracked.", "default": false } } } ] }, { "title": "Webhook", "allOf": [ { "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an action.", "type": "integer", "readOnly": true, "example": 96 }, "campaign_id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "parent_action_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the parent action, if the action occurred within an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "type": "string", "description": "The name of the action, if it exists.", "readOnly": true, "example": "Opening Message" }, "layout": { "type": "string", "description": "The layout used for the action, if it exists.", "readOnly": true }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "body": { "type": "string", "description": "The body of the action. You cannot modify the body if you created it with our drag-and-drop editor." }, "type": { "type": "string", "description": "The type of action.", "enum": [ "webhook" ], "readOnly": true }, "url": { "type": "string", "description": "The URL to send a webhook to, applies to `webhook` type actions.", "example": "https://my.example.com/webhook" }, "headers": { "x-scalar-ignore": true, "description": "A JSON string containing header objects with `name` and `value`. Names and values must be strings, with no non-ASCII characters or spaces. You can't overwrite reserved headers.", "type": "string", "format": "json", "example": "[{\"name\":\"X-Mailgun-Tag\",\"value\":\"my-cool-tag\"},{\"name\":\"X-Custom-Header\",\"value\":\"custom-value\"}]" }, "method": { "description": "The HTTP method for your webhook.", "type": "string", "enum": [ "get", "post", "put", "delete", "patch" ], "example": "post" }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." } } } ] } ] }, "sending_state": { "x-scalar-ignore": true, "type": "string", "enum": [ "automatic", "draft", "off" ], "description": "Determines the sending behavior for the action. `automatic` sends the action automatically when triggered; `draft` queues drafts when the action is triggered; or `off` to disable the action." }, "languageVariantMetrics": { "x-scalar-ignore": true, "type": "object", "description": "Metrics for each language variant of a multi-language message, keyed by the variant's action ID. Only returned when you request metrics for a multi-language branch action.\n", "additionalProperties": { "type": "object", "properties": { "language": { "type": "string", "description": "The language code for this variant, such as `es` or `fr-CA`. Empty for the default variant—the one that people fall back to when no other variant matches their language.", "example": "es" }, "default": { "type": "boolean", "description": "Whether this is the default variant. Exactly one variant per multi-language message is the default, and it always has an empty `language`.", "example": false }, "series": { "x-scalar-ignore": true, "description": "Metrics grouped by the requested resolution. Each property is an array where each entry represents one period, such as one day.", "type": "object", "properties": { "attempted": { "type": "array", "items": { "type": "integer" }, "description": "The number of `attempted` messages." }, "bounced": { "type": "array", "items": { "type": "integer" }, "description": "The number of `bounced` messages." }, "clicked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `clicked` messages." }, "human_clicked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `clicked` emails excluding machine clicks. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "machine_clicked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `clicked` emails attributed to machines—security scanners, bot user agents, known proxy services, and repetitive click patterns. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "converted": { "type": "array", "items": { "type": "integer" }, "description": "The number of `converted` messages." }, "created": { "type": "array", "items": { "type": "integer" }, "description": "The number of `created` messages." }, "deferred": { "type": "array", "items": { "type": "integer" }, "description": "The number of `deferred` messages." }, "delivered": { "type": "array", "items": { "type": "integer" }, "description": "The number of `delivered` messages." }, "drafted": { "type": "array", "items": { "type": "integer" }, "description": "The number of `drafted` messages." }, "failed": { "type": "array", "items": { "type": "integer" }, "description": "The number of `failed` messages." }, "opened": { "type": "array", "items": { "type": "integer" }, "description": "The number of `opened` messages." }, "human_opened": { "type": "array", "items": { "type": "integer" }, "description": "The number of `opened` emails excluding machine opens. This metric is reliable starting March 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_opened": { "type": "array", "items": { "type": "integer" }, "description": "The number of `opened` emails attributed to machines. This metric is reliable starting March 20, 2025." }, "sent": { "type": "array", "items": { "type": "integer" }, "description": "The number of sent messages." }, "spammed": { "type": "array", "items": { "type": "integer" }, "description": "The number of spam complaints." }, "suppressed": { "type": "array", "items": { "type": "integer" }, "description": "The number of `suppressed` messages." }, "undeliverable": { "type": "array", "items": { "type": "integer" }, "description": "The number of `undeliverable` messages." }, "topic_unsubscribed": { "type": "array", "items": { "type": "integer" }, "description": "The number of topic unsubscribes in a given period." }, "unsubscribed": { "type": "array", "items": { "type": "integer" }, "description": "The number of unsubscribes attributed to the automation or message." }, "replied": { "type": "array", "items": { "type": "integer" }, "description": "The number of SMS/MMS messages a person replied to with a keyword. [Learn more about inbound messages](/messaging/channels/sms/inbound/get-started/)." }, "untracked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `sent` emails whose open pixel we withheld because the person opted out of open tracking. We exclude these from the open-rate denominator; click tracking is unaffected." }, "open_untracked": { "type": "array", "items": { "type": "integer" }, "description": "The number of emails delivered with open tracking inactive for any reason—including the consent opt-outs that `untracked` counts and messages sent with open tracking disabled. We subtract these from the open-rate denominator." }, "link_untracked": { "type": "array", "items": { "type": "integer" }, "description": "The number of emails delivered with link tracking inactive for any reason. We subtract these from the click-rate denominator." }, "tracking_consent_granted": { "type": "array", "items": { "type": "integer" }, "description": "The number of people who granted consent to email open tracking in the period." }, "tracking_consent_denied": { "type": "array", "items": { "type": "integer" }, "description": "The number of people who denied consent to email open tracking in the period." } } } } } }, "periodMessageMetrics": { "x-scalar-ignore": true, "description": "Metrics grouped by the requested resolution. Each property is an array where each entry represents one period, such as one day.", "type": "object", "properties": { "attempted": { "type": "array", "items": { "type": "integer" }, "description": "The number of `attempted` messages." }, "bounced": { "type": "array", "items": { "type": "integer" }, "description": "The number of `bounced` messages." }, "clicked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `clicked` messages." }, "human_clicked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `clicked` emails excluding machine clicks. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "machine_clicked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `clicked` emails attributed to machines—security scanners, bot user agents, known proxy services, and repetitive click patterns. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "converted": { "type": "array", "items": { "type": "integer" }, "description": "The number of `converted` messages." }, "created": { "type": "array", "items": { "type": "integer" }, "description": "The number of `created` messages." }, "deferred": { "type": "array", "items": { "type": "integer" }, "description": "The number of `deferred` messages." }, "delivered": { "type": "array", "items": { "type": "integer" }, "description": "The number of `delivered` messages." }, "drafted": { "type": "array", "items": { "type": "integer" }, "description": "The number of `drafted` messages." }, "failed": { "type": "array", "items": { "type": "integer" }, "description": "The number of `failed` messages." }, "opened": { "type": "array", "items": { "type": "integer" }, "description": "The number of `opened` messages." }, "human_opened": { "type": "array", "items": { "type": "integer" }, "description": "The number of `opened` emails excluding machine opens. This metric is reliable starting March 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_opened": { "type": "array", "items": { "type": "integer" }, "description": "The number of `opened` emails attributed to machines. This metric is reliable starting March 20, 2025." }, "sent": { "type": "array", "items": { "type": "integer" }, "description": "The number of sent messages." }, "spammed": { "type": "array", "items": { "type": "integer" }, "description": "The number of spam complaints." }, "suppressed": { "type": "array", "items": { "type": "integer" }, "description": "The number of `suppressed` messages." }, "undeliverable": { "type": "array", "items": { "type": "integer" }, "description": "The number of `undeliverable` messages." }, "topic_unsubscribed": { "type": "array", "items": { "type": "integer" }, "description": "The number of topic unsubscribes in a given period." }, "unsubscribed": { "type": "array", "items": { "type": "integer" }, "description": "The number of unsubscribes attributed to the automation or message." }, "replied": { "type": "array", "items": { "type": "integer" }, "description": "The number of SMS/MMS messages a person replied to with a keyword. [Learn more about inbound messages](/messaging/channels/sms/inbound/get-started/)." }, "untracked": { "type": "array", "items": { "type": "integer" }, "description": "The number of `sent` emails whose open pixel we withheld because the person opted out of open tracking. We exclude these from the open-rate denominator; click tracking is unaffected." }, "open_untracked": { "type": "array", "items": { "type": "integer" }, "description": "The number of emails delivered with open tracking inactive for any reason—including the consent opt-outs that `untracked` counts and messages sent with open tracking disabled. We subtract these from the open-rate denominator." }, "link_untracked": { "type": "array", "items": { "type": "integer" }, "description": "The number of emails delivered with link tracking inactive for any reason. We subtract these from the click-rate denominator." }, "tracking_consent_granted": { "type": "array", "items": { "type": "integer" }, "description": "The number of people who granted consent to email open tracking in the period." }, "tracking_consent_denied": { "type": "array", "items": { "type": "integer" }, "description": "The number of people who denied consent to email open tracking in the period." } } }, "webhookMetrics": { "x-scalar-ignore": true, "type": "object", "properties": { "2xx": { "type": "integer", "description": "The number of 2xx responses." }, "3xx": { "type": "integer", "description": "The number of 3xx responses." }, "4xx": { "type": "integer", "description": "The number of 4xx responses." }, "5xx": { "type": "integer", "description": "The number of 5xx responses." } } }, "messageMetrics": { "x-scalar-ignore": true, "type": "object", "description": "Metrics for an individual instance of a message; each item in the object represents the timestamp when a message achieved a particular metric. This object only contains metrics that have been recorded.", "properties": { "bounced": { "type": "integer", "description": "The timestamp when the message `bounced`." }, "clicked": { "type": "integer", "description": "The timestamp when the message was `clicked`." }, "human_clicked": { "type": "integer", "description": "The number of `clicked` messages excluding machine clicks. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_clicked": { "type": "integer", "description": "The number of `clicked` messages attributed to machines. This metric is reliable starting April 20, 2025." }, "converted": { "type": "integer", "description": "The timestamp when the message was `converted`." }, "created": { "type": "integer", "description": "The timestamp when the message was `created`." }, "delivered": { "type": "integer", "description": "The timestamp when the message was `delivered`." }, "drafted": { "type": "integer", "description": "The timestamp when the message was `drafted`." }, "dropped": { "type": "integer", "description": "The timestamp when the message was `dropped`." }, "failed": { "type": "integer", "description": "The timestamp when the message `failed`." }, "opened": { "type": "integer", "description": "The timestamp when the message was `opened`." }, "human_opened": { "type": "integer", "description": "The number of `opened` messages excluding machine opens. This metric is reliable starting March 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics)." }, "prefetch_opened": { "type": "integer", "description": "The number of `opened` messages attributed to machines. This metric is reliable starting March 20, 2025." }, "sent": { "type": "integer", "description": "The timestamp when the message was `sent`." }, "spammed": { "type": "integer", "description": "The timestamp when the message was marked as spam." }, "undeliverable": { "type": "integer", "description": "The timestamp when the message became `undeliverable`." }, "unsubscribed": { "type": "integer", "description": "The timestamp when a person unsubscribed based on this message." } } }, "messageTotalMetrics": { "x-scalar-ignore": true, "type": "object", "description": "Total metrics over the lifespan of the requested item.", "properties": { "bounced": { "type": "integer", "description": "The number of `bounced` messages." }, "clicked": { "type": "integer", "description": "The number of `clicked` messages." }, "converted": { "type": "integer", "description": "The number of `converted` messages." }, "created": { "type": "integer", "description": "The number of `created` messages." }, "delivered": { "type": "integer", "description": "The number of `delivered` messages." }, "drafted": { "type": "integer", "description": "The number of `drafted` messages." }, "dropped": { "type": "integer", "description": "The number of `dropped` messages." }, "failed": { "type": "integer", "description": "The number of `failed` messages." }, "opened": { "type": "integer", "description": "The number of `opened` messages" }, "sent": { "type": "integer", "description": "The number of `sent` messages" }, "spammed": { "type": "integer", "description": "The number of messages marked as spam." }, "undeliverable": { "type": "integer", "description": "The number of `undeliverable` messages." }, "unsubscribed": { "type": "integer", "description": "The number of unsubscribes attributed to messages." } } }, "linkMetrics": { "x-scalar-ignore": true, "type": "object", "properties": { "link": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the link.", "example": 1234 }, "href": { "type": "string", "description": "The link destination—a URL, mailto, etc.", "example": "https://docs.customer.io" } } }, "metric": { "type": "object", "description": "Contains metrics for the link.", "properties": { "series": { "type": "object", "properties": { "clicked": { "type": "array", "description": "An array of results from oldest to newest, where each result indicates a period.", "items": { "type": "integer" }, "example": [ 1, 3, 5, 7 ] }, "human_clicked": { "type": "array", "description": "An array of human click counts (clicks excluding machine clicks) from oldest to newest, where each result indicates a period. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics).", "items": { "type": "integer" }, "example": [ 1, 2, 3, 4 ] }, "machine_clicked": { "type": "array", "description": "An array of machine click counts (clicks attributed to bots or prefetching) from oldest to newest, where each result indicates a period. This metric is reliable starting April 20, 2025. [Learn more](/messaging/metrics/analytics/#delivery-metrics).", "items": { "type": "integer" }, "example": [ 0, 1, 1, 2 ] } } } } } } }, "campaignObject": { "x-scalar-ignore": true, "type": "object", "oneOf": [ { "title": "Segment", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "segment" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "trigger_segment_ids": { "description": "A list of segments used in the automation trigger, returned if the automation trigger included one or more segment conditions.", "type": "array", "items": { "type": "integer" }, "example": [ 90 ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] }, "msg_templates": { "type": "array", "deprecated": true, "description": "Indicates the message templates used in this automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The message type the template represents.", "enum": [ "email", "sms", "push", "slack" ] }, "id": { "type": "integer", "description": "The identifier for the template." } } } } } }, { "title": "Event", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "event" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] }, "event_name": { "description": "The name of the event. How you reference the event in automations or segments.", "type": "string" } } }, { "title": "Form", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "form" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] } } }, { "title": "Date", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "date" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] }, "frequency": { "description": "How often a person will receive this automation based on the date specified in the automation trigger.", "type": "string", "enum": [ "once", "monthly", "yearly" ] }, "date_attribute": { "description": "The attribute on people's profiles you use to configure the date of the automation trigger.", "type": "string" }, "timezone": { "description": "The time zone you set to configure the date of the automation trigger.", "type": "string", "example": "America/Chicago" }, "use_customer_timezone": { "description": "If you chose \"the user's time zone\" while configuring the date of the automation trigger, this is `true`. Otherwise, you set a specific time zone so it's `false`.", "type": "boolean" }, "start_hour": { "description": "The hour you set the automation to trigger. Follows the 24-hour clock.", "type": "integer" }, "start_minutes": { "description": "The minutes you set the automation to trigger. Follows the 24-hour clock.", "type": "integer" } } }, { "title": "Relationship", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "relationship" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] }, "object_type_id": { "x-scalar-ignore": true, "description": "The object type ID of the trigger.", "type": "integer" }, "filter_object_attributes": { "x-scalar-ignore": true, "description": "A list of object attributes used in the automation filter, returned if the automation audience was filtered on one or more object attributes.", "type": "string", "example": "{\"and\":[{\"object_attribute\":{\"type_id\":1,\"field\":\"name\",\"operator\":\"eq\",\"value\":\"sfa\"}},{\"object_attribute\":{\"type_id\":1,\"field\":\"renewal_date\",\"operator\":\"eq\",\"value\":\"sdfs\"}}]}" }, "filter_relationship_attributes": { "x-scalar-ignore": true, "description": "A list of relationship attributes used in the automation filter, returned if the automation audience was filtered on one or more relationship attributes.", "type": "string", "example": "{\"and\":[{\"relationship_attribute\":{\"type_id\":1,\"field\":\"email\",\"operator\":\"eq\",\"value\":\"dscs@test.com\"}},{\"relationship_attribute\":{\"type_id\":1,\"field\":\"trig\",\"operator\":\"eq\",\"value\":\"false\"}}]}" }, "audience": { "description": "Defines the people who will start a journey in your automation.", "type": "object", "properties": { "type": { "description": "The selected audience type. `0` means person added to object; `1` can mean every or certain people in the object. Filters appear only for subset audiences.", "type": "integer", "minimum": 0, "maximum": 1 }, "person_filters": { "description": "Returns the profile attributes you filtered the audience by, if any. Only applies to `type 1`, \"Certain people in the object\".", "type": "object", "example": "{\"and\":[{\"attribute\":{\"field\":\"title\",\"operator\":\"eq\",\"value\":\"asdca\"}}]}" }, "relationship_filters": { "description": "Returns the relationship attributes you filtered the audience by, if any. Only applies to `type 1`, \"Certain people in the object\".", "type": "object", "example": "{\"and\":[{\"relationship_attribute\":{\"type_id\":1,\"field\":\"trig\",\"operator\":\"eq\",\"value\":\"asd\"}}]}" } } }, "relationship_attribute_triggers": { "description": "A list of relationship attributes used to trigger the automation.", "type": "object", "example": "{\"and\":[{\"relationship_attribute\":{\"type_id\":1,\"field\":\"trig\",\"operator\":\"eq\",\"value\":\"true\"}}]}" } } }, { "title": "Object", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "object" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] }, "object_type_id": { "x-scalar-ignore": true, "description": "The object type ID of the trigger.", "type": "integer" }, "filter_object_attributes": { "x-scalar-ignore": true, "description": "A list of object attributes used in the automation filter, returned if the automation audience was filtered on one or more object attributes.", "type": "string", "example": "{\"and\":[{\"object_attribute\":{\"type_id\":1,\"field\":\"name\",\"operator\":\"eq\",\"value\":\"sfa\"}},{\"object_attribute\":{\"type_id\":1,\"field\":\"renewal_date\",\"operator\":\"eq\",\"value\":\"sdfs\"}}]}" }, "filter_relationship_attributes": { "x-scalar-ignore": true, "description": "A list of relationship attributes used in the automation filter, returned if the automation audience was filtered on one or more relationship attributes.", "type": "string", "example": "{\"and\":[{\"relationship_attribute\":{\"type_id\":1,\"field\":\"email\",\"operator\":\"eq\",\"value\":\"dscs@test.com\"}},{\"relationship_attribute\":{\"type_id\":1,\"field\":\"trig\",\"operator\":\"eq\",\"value\":\"false\"}}]}" }, "audience": { "description": "Defines the people who will start a journey in your automation.", "type": "object", "properties": { "type": { "description": "The type of audience selected. \"Every person in the object\" is `1`. \"Certain people in the object\" is also `1`. \"Certain people\" will always have one or more audience filters (see below). \"Every person\" will never have an audience filter.", "type": "integer", "minimum": 0, "maximum": 1 }, "person_filters": { "description": "Returns the profile attributes you filtered the audience by, if any. Only applies to `type 1`, \"Certain people in the object\".", "type": "object", "example": "{\"and\":[{\"attribute\":{\"field\":\"title\",\"operator\":\"eq\",\"value\":\"asdca\"}}]}" }, "relationship_filters": { "description": "Returns the relationship attributes you filtered the audience by, if any. Only applies to `type 1`, \"Certain people in the object\".", "type": "object", "example": "{\"and\":[{\"relationship_attribute\":{\"type_id\":1,\"field\":\"trig\",\"operator\":\"eq\",\"value\":\"asd\"}}]}" } } }, "object_attribute_triggers": { "description": "A list of object attributes used to trigger the automation.", "type": "object", "example": "{\"and\":[{\"object_attribute\":{\"type_id\":1,\"field\":\"name\",\"operator\":\"eq\",\"value\":\"sfa\"}},{\"object_attribute\":{\"type_id\":1,\"field\":\"renewal_date\",\"operator\":\"eq\",\"value\":\"sdfs\"}}]}" } } }, { "title": "Webhook", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "description": "The identifier for an automation.", "type": "integer", "example": 5 }, "deduplicate_id": { "x-scalar-ignore": true, "type": "string", "readOnly": true, "description": "An identifier in the format `id:timestamp` where the id is for the object you're working with (Automations, Deliveries, Exports, Identities, Newsletters, Segments, and Templates), and the timestamp is the last time the object was updated.", "example": "15:1492548073" }, "name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "type": { "type": "string", "deprecated": true, "description": "The type of automation trigger. **Sunsetting on March 30, 2025**", "enum": [ "webhook" ] }, "created": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was created.", "example": 1552341937, "readOnly": true }, "updated": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date time when the referenced ID was last updated.", "example": 1552341937, "readOnly": true }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "webhook_id": { "description": "The ID of the webhook trigger generated by Customer.io.", "type": "integer" } } } ] }, "esp_suppression": { "x-scalar-ignore": true, "type": "object", "properties": { "category": { "type": "string", "description": "The reason the addresses are suppressed.", "enum": [ "bounces", "spam" ], "example": "bounces" }, "suppressions": { "type": "array", "description": "The addresses suppressed in this category.", "items": { "type": "object", "properties": { "created": { "type": "integer", "format": "Unix timestamp", "description": "The timestamp (in seconds), when the ESP suppressed the address.", "example": 1650895738 }, "email": { "type": "string", "description": "The email address that the ESP suppressed.", "example": "bounced.person@example.com" }, "reason": { "type": "string", "description": "The reason for the suppression, as [recorded by Mailgun](https://documentation.mailgun.com/en/latest/api-suppressions.html).", "example": "Uploaded manually via api.customer.io" }, "status": { "type": "string", "description": "The status code for the suppression, as [recorded by mailgun](https://documentation.mailgun.com/en/latest/api-suppressions.html). This is normally `550`.", "example": "550" } } } } } }, "pushTitle": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "pushBody": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "pushLink": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "pushImage": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." }, "customAndroidProps": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } }, "allAndroidProps": { "x-scalar-ignore": true, "allOf": [ { "type": "object", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." } } }, { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } ] }, "fcmBasicPush": { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The parent object for all custom push payloads.", "required": [ "notification" ], "properties": { "notification": { "type": "object", "required": [ "body" ], "description": "Contains properties interpreted by the SDK except for the `link`.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } }, "data": { "type": "object", "description": "Contains the `link` property (interpreted by the SDK) and additional properties that you want to pass to your app.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." } } } } } } }, "fcmAndroidWithSdk": { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "description": "The parent object for all push payloads.", "oneOf": [ { "title": "Data object only", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "description": "Contains all properties interpreted by the SDK.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." }, "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." } } }, "android": { "type": "object", "description": "Contains properties that are **not** interpreted by the SDK but are defined by FCM. You need to write your own code to handle these Android push features.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } }, { "title": "Notification and data object", "type": "object", "required": [ "notification" ], "properties": { "notification": { "type": "object", "description": "Contains properties interpreted by the SDK except for the `link`.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } }, "data": { "type": "object", "description": "Contains the `link` property (interpreted by the SDK) and additional properties that you want to pass to your app.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." } } }, "android": { "type": "object", "description": "Contains properties that are **not** interpreted by the SDK but are defined by FCM. You need to write your own code to handle these Android push features.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } } ] } } }, "fcmAndroidWithoutSdk": { "x-scalar-ignore": true, "type": "object", "description": "A custom push payload for Android devices.", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The parent object for Android custom push payloads.", "properties": { "notification": { "type": "object", "description": "Contains the push body and title.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." } } }, "data": { "type": "object", "description": "Contains key-value pairs that your app interprets.", "additionalProperties": { "x-additionalPropertiesName": "Attachment Names", "x-doNotRender": true, "type": "string" } }, "android": { "type": "object", "description": "Contains custom push options for your notification.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } } } }, "fcmAndroid": { "x-scalar-ignore": true, "oneOf": [ { "title": "SDK Integration", "type": "object", "required": [ "message" ], "properties": { "message": { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "description": "The parent object for all push payloads.", "oneOf": [ { "title": "Data object only", "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "description": "Contains all properties interpreted by the SDK.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." }, "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." } } }, "android": { "type": "object", "description": "Contains properties that are **not** interpreted by the SDK but are defined by FCM. You need to write your own code to handle these Android push features.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } }, { "title": "Notification and data object", "type": "object", "required": [ "notification" ], "properties": { "notification": { "type": "object", "description": "Contains properties interpreted by the SDK except for the `link`.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } }, "data": { "type": "object", "description": "Contains the `link` property (interpreted by the SDK) and additional properties that you want to pass to your app.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." } } }, "android": { "type": "object", "description": "Contains properties that are **not** interpreted by the SDK but are defined by FCM. You need to write your own code to handle these Android push features.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } } ] } } } } }, { "title": "Custom Integration", "type": "object", "required": [ "message" ], "properties": { "message": { "x-scalar-ignore": true, "type": "object", "description": "A custom push payload for Android devices.", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The parent object for Android custom push payloads.", "properties": { "notification": { "type": "object", "description": "Contains the push body and title.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." } } }, "data": { "type": "object", "description": "Contains key-value pairs that your app interprets.", "additionalProperties": { "x-additionalPropertiesName": "Attachment Names", "x-doNotRender": true, "type": "string" } }, "android": { "type": "object", "description": "Contains custom push options for your notification.", "properties": { "notification": { "x-scalar-ignore": true, "type": "object", "description": "Properties supported specifically by Android on FCM.", "properties": { "icon": { "type": "string", "description": "Sets the notification icon to `myicon` for drawable resource `myicon`. If you don't send this key, FCM displays the launcher icon from your app manifest." }, "sound": { "type": "string", "description": "The sound that plays when the device receives the notification. Supports `\"default\"` or the filename of a sound resource bundled in your app. Sound files must reside in `/res/raw/`." }, "tag": { "type": "string", "description": "An identifier you use to replace an existing notification. If a notification with the same tag is already showing, the new one replaces it. Leave it empty to create a new notification each time." }, "color": { "type": "string", "description": "The notification's icon color in `#rrggbb` format." }, "click_action": { "type": "string", "description": "The action that occurs when a user taps on the notification. Launches an activity with a matching intent filter when a person taps the notification." }, "body_loc_key": { "type": "string", "description": "String resource key used to localize the body text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "body_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `body_loc_key` to localize the body text to the user's current localization. See Formatting and Styling for more information." }, "title_loc_key": { "type": "string", "description": "String resource key used to localize the title text. See Android [String resources](https://developer.android.com/guide/topics/resources/string-resource/)." }, "title_loc_arg": { "type": "string", "description": "Variable string values used in place of the format specifiers in `title_loc_key` to localize the title text to the user's current localization. See Formatting and Styling for more information." } } } } } } } } } } } ] }, "iosSharedOptions": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } }, "fcmIosWithSdk": { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The base object for all FCM payloads.", "required": [ "apns" ], "properties": { "apns": { "type": "object", "required": [ "payload" ], "description": "Defines a payload for iOS devices sent through Firebase Cloud Messaging (FCM).", "properties": { "headers": { "description": "Headers defined by [Apple's payload reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) that you want to pass through FCM.", "type": "object" }, "payload": { "type": "object", "description": "Contains a push payload.", "properties": { "CIO": { "type": "object", "description": "Contains properties interpreted by the Customer.io iOS SDK.", "required": [ "push" ], "properties": { "push": { "type": "object", "description": "A push payload for the iOS SDK.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } }, "additionalProperties": { "description": "Additional properties that you've set up your app to interpret outside of the Customer.io SDK.", "x-additionalPropertiesName": "Custom key-value pairs" } } } } } } } }, "fcmIosWithoutSdk": { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "type": "object", "required": [ "apns" ], "description": "The base object for all Firebase payloads.", "properties": { "apns": { "type": "object", "description": "Defines a push notification for iOS devices.", "required": [ "payload" ], "properties": { "headers": { "description": "Headers defined by [Apple's payload reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) that you want to pass through FCM.", "type": "object" }, "payload": { "type": "object", "properties": { "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } } } } } } } } }, "apsBasicPush": { "x-scalar-ignore": true, "type": "object", "required": [ "aps" ], "properties": { "aps": { "type": "object", "description": "A push payload intended for an iOS device.", "required": [ "alert" ], "properties": { "alert": { "type": "object", "description": "An object containing the push title and body", "required": [ "body" ], "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." } } } } }, "CIO": { "type": "object", "required": [ "push" ], "description": "Contains options supported by the Customer.io SDK.", "properties": { "push": { "type": "object", "description": "Describes push notification options supported by the CIO SDK.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } } } }, "apnsWithoutSdk": { "x-scalar-ignore": true, "type": "object", "properties": { "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } } }, "iosFcmAndApns": { "x-scalar-ignore": true, "description": "Your payload changes depending on whether you send to iOS devices through Google's Firebase Cloud Messaging (FCM) or Apple's Push Notification service (APNs).", "oneOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "message" ], "properties": { "message": { "type": "object", "description": "The base object for all FCM payloads.", "required": [ "apns" ], "properties": { "apns": { "type": "object", "required": [ "payload" ], "description": "Defines a payload for iOS devices sent through Firebase Cloud Messaging (FCM).", "properties": { "headers": { "description": "Headers defined by [Apple's payload reference](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/sending_notification_requests_to_apns) that you want to pass through FCM.", "type": "object" }, "payload": { "type": "object", "description": "Contains a push payload.", "properties": { "CIO": { "type": "object", "description": "Contains properties interpreted by the Customer.io iOS SDK.", "required": [ "push" ], "properties": { "push": { "type": "object", "description": "A push payload for the iOS SDK.", "properties": { "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } }, "additionalProperties": { "description": "Additional properties that you've set up your app to interpret outside of the Customer.io SDK.", "x-additionalPropertiesName": "Custom key-value pairs" } } } } } } } }, { "x-scalar-ignore": true, "type": "object", "properties": { "CIO": { "type": "object", "required": [ "push" ], "description": "Contains options supported by the Customer.io SDK.", "properties": { "push": { "type": "object", "description": "Describes push notification options supported by the CIO SDK.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } } } ] }, "apnsWithSdk": { "x-scalar-ignore": true, "type": "object", "properties": { "CIO": { "type": "object", "required": [ "push" ], "description": "Contains options supported by the Customer.io SDK.", "properties": { "push": { "type": "object", "description": "Describes push notification options supported by the CIO SDK.", "properties": { "link": { "x-scalar-ignore": true, "type": "string", "description": "A deep link (to a page in your app), or a link to a web page." }, "image": { "x-scalar-ignore": true, "type": "string", "description": "The URL of an HTTPS image that you want to use for your message." } } } } }, "aps": { "x-scalar-ignore": true, "type": "object", "description": "A push payload intended for an iOS device.", "properties": { "alert": { "oneOf": [ { "title": "Simple alert", "type": "string", "description": "A simple alert message." }, { "title": "Complex alert", "type": "object", "properties": { "body": { "x-scalar-ignore": true, "type": "string", "description": "The body of your push notification." }, "title": { "x-scalar-ignore": true, "type": "string", "description": "The title of your push notification." }, "subtitle": { "description": "Additional information that explains the purpose of the notification.", "type": "string" }, "launch-image": { "description": "The name of the launch image file you want to display. When a user launches your app, they'll see this image or storyboard file rather than your app’s normal launch image.", "type": "string" }, "title-loc-key": { "description": "The key for a localized title string in your app’s Localizable.strings files.", "type": "string" }, "title-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your title string. Each %@ character in the title-loc-key is replaced by a value from this array, in the order they appear in the title string.", "items": { "type": "string" } }, "subtitle-loc-key": { "description": "The key for a localized subtitle string in your app’s Localizable.strings file.", "type": "string" }, "subtitle-loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your subtitle string. Each %@ character in the subtitle-loc-key is replaced by a value from this array, in the order they appear in the subtitle string.", "items": { "type": "string" } }, "loc-key": { "description": "The key for a localized message string in your app’s Localizable.strings file.", "type": "string" }, "loc-args": { "type": "array", "description": "An array of replacement value strings for variables in your message text. Each %@ character in the loc-key is replaced by a value from this array, in the order they appear in the message body.", "items": { "type": "string" } } } } ] }, "badge": { "type": "integer", "description": "The number you want to display on your app's icon. Set to 0 to remove the current badge, if any." }, "sound": { "oneOf": [ { "title": "Regular alert", "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound. For critical alerts, you'll pass an object instead." }, { "title": "Critical alert", "type": "object", "properties": { "critical": { "type": "integer", "description": "1 indicates critical. 0 is not critical." }, "name": { "type": "string", "description": "The name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s container directory. Use “default” to play the system sound." }, "volume": { "type": "number", "description": "The volume for a critical alert between 0 and 1, where 0 is silent and 1 is full volume." } } } ] }, "thread-id": { "type": "string", "description": "An identifier to group related notifications." }, "category": { "type": "string", "description": "The notification’s type. This string must correspond to the identifier of one of the `UNNotificationCategory` objects you register at launch time." }, "content-available": { "type": "integer", "description": "The background notification flag. Use `1` without an `alert` to perform a silent update. `0` indicates a normal push notification." }, "mutable-content": { "type": "integer", "description": "Set this to `1` if you use the Customer.io SDK, so you can support images and delivered metrics in your push notifications. It passes the notification to your service extension before delivery." }, "target-content-id": { "type": "string", "description": "The identifier of the window brought forward." }, "interruption-level": { "type": "string", "description": "Indicates the importance and delivery timing of a notification.", "enum": [ "passive", "active", "time-sensitive", "critical" ] }, "relevance-score": { "type": "number", "description": "A number between 0 and 1. The highest score is considered the \"most relevant\" and is featured in the notification summary." } } } } }, "widgetColor": { "x-scalar-ignore": true, "type": "string", "description": "The color you want to use for this content. You can only set values here that are defined under [**Content** > **In-App Messages**](https://fly.customer.io/env/last/in-app-messages)." }, "widgetRadius": { "x-scalar-ignore": true, "type": "integer", "description": "Sets the radius of corners for an item in pixels, similar to the `border-radius` CSS property." }, "widgetHeight": { "x-scalar-ignore": true, "type": "integer", "description": "The height of the component in pixels, if you want to constrain it. If you don't set a height or width, we'll scale your content to fit your message or container." }, "widgetWidth": { "x-scalar-ignore": true, "type": "integer", "description": "The width of the component in pixels, if you want to constrain it. If you don't set a height or width, we'll scale your content to fit your message or container." }, "widgetComponents": { "x-scalar-ignore": true, "description": "An array of child components that you want to make available inside this widget.", "type": "array", "items": { "type": "object" } }, "widgetMainAxisAlignment": { "x-scalar-ignore": true, "type": "string", "description": "The mainAxisAlignment property supports the following options.", "enum": [ "start", "end", "spaceBetween", "spaceAround", "spaceEvenly" ] }, "widgetCrossAxisAlignment": { "x-scalar-ignore": true, "type": "string", "description": "The crossAxisAlignment property supports the following options", "enum": [ "center", "start", "end", "center", "stretch", "baseline" ] }, "textWidget": { "x-scalar-ignore": true, "description": "Displays text in your message.", "type": "object", "required": [ "type", "text" ], "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "textWidget" ] }, "text": { "type": "string", "description": "The text you want to display.", "example": "$person.name" }, "style": { "type": "string", "description": "The style of text you want to display. You can only set values here that are defined under [**Content** > **In-App Messages**](https://fly.customer.io/env/last/in-app-messages)." }, "color": { "x-scalar-ignore": true, "type": "string", "description": "The color you want to use for this content. You can only set values here that are defined under [**Content** > **In-App Messages**](https://fly.customer.io/env/last/in-app-messages)." }, "textAlign": { "type": "string", "description": "How you want to align this text.", "enum": [ "center", "right", "left", "start", "end", "justify" ] }, "maxLines": { "type": "integer", "description": "The maximum lines of text you want to display. Text over this limit is controlled by the `overflow` property. If unset, the message displays an unlimited number of lines." }, "overflow": { "type": "string", "description": "Determines how to handle text that overflows the `maxLines` limit (if set). By default, we cut off overflowing text with ellipsis (`...`).", "enum": [ "ellipsis", "fade", "clip" ] } } }, "imageWidget": { "x-scalar-ignore": true, "description": "Displays an image. You can provide the URL of an image. Or, if you use the template designer, you can upload an image and host it directly.", "type": "object", "required": [ "type", "image" ], "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "imageWidget" ] }, "image": { "description": "The URL of the image that you want ot use in your message.", "example": "$person.imageUrl" }, "fit": { "type": "string", "description": "Determines how the image fits your message. Defaults to `cover`.", "enum": [ "none", "fitWidth", "cover", "contain", "scaleDown", "fill", "fitHeight" ] }, "height": { "x-scalar-ignore": true, "type": "integer", "description": "The height of the component in pixels, if you want to constrain it. If you don't set a height or width, we'll scale your content to fit your message or container." }, "width": { "x-scalar-ignore": true, "type": "integer", "description": "The width of the component in pixels, if you want to constrain it. If you don't set a height or width, we'll scale your content to fit your message or container." }, "cornerRadius": { "x-scalar-ignore": true, "type": "integer", "description": "Sets the radius of corners for an item in pixels, similar to the `border-radius` CSS property." }, "fadeInDuration": { "type": "integer", "description": "The durration for the image to fade in, in milliseconds, similar to the `fadeIn` CSS transition property." } } }, "iconWidget": { "x-scalar-ignore": true, "description": "Displays an icon from an icon font that you've loaded into your app or project. You must load your icon font in the assets section of your app configuration.", "type": "object", "required": [ "type", "color", "value" ], "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "iconWidget" ] }, "color": { "x-scalar-ignore": true, "type": "string", "description": "The color you want to use for this content. You can only set values here that are defined under [**Content** > **In-App Messages**](https://fly.customer.io/env/last/in-app-messages)." }, "font": { "description": "The icon font you want to use." }, "size": { "description": "The pixel size of the icon.", "type": "integer" }, "value": { "description": "The value of the icon that you want to use. For example, for font-awesome, you'd use the name of the icon.", "type": "string" } } }, "blockWidget": { "x-scalar-ignore": true, "type": "object", "description": "A widget that provides visual design for one or more child components.", "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "blockWidget" ] }, "safeInsets": { "type": "boolean", "description": "Based on the env `safe-area-inset-*` CSS properties. Set to true to ensure that the block can't overflow the defined screen or the defined area of your message. Defaults to `false`.", "default": false }, "padding": { "type": "array", "description": "Defines padding for the block, based on the values set under *Branding* > *Padding*. As with the CSS `padding` property, values in the array represent top, right, bottom, and left padding.", "maxItems": 4, "items": { "type": "string", "description": "The padding label you set under *Branding* > *Padding*." } }, "backgroundColor": { "type": "string", "description": "The background color for your block. You must set a value defined under *Branding* > *Colors*." }, "borderColor": { "type": "string", "description": "The border color for your block, if you set a border width greater than 0. You must set a value defined under *Branding* > *Colors*." }, "borderWidth": { "type": "integer", "description": "The width of the border for this block in pixels." }, "borderRadius": { "x-scalar-ignore": true, "type": "integer", "description": "Sets the radius of corners for an item in pixels, similar to the `border-radius` CSS property." }, "height": { "x-scalar-ignore": true, "type": "integer", "description": "The height of the component in pixels, if you want to constrain it. If you don't set a height or width, we'll scale your content to fit your message or container." }, "backgroundImage": { "type": "string", "description": "Set a background image for the block", "example": "$user.backgroundImage," }, "flex": { "type": "integer", "description": "The single digit syntax for the CSS `flex` property. The value you use here determines the propotional amount of space the block consumes in a parent container." }, "components": { "x-scalar-ignore": true, "description": "An array of child components that you want to make available inside this widget.", "type": "array", "items": { "type": "object" } } } }, "conditionalWidget": { "x-scalar-ignore": true, "description": "Set a true/false condition determining which content to show. Use a variable in your condition to populate the condition when you set up your message in Customer.io.", "type": "object", "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "conditionalWidget" ] }, "condition": { "type": "string", "description": "The condition you want to evaluate. You can evaluate a condition using `>`, `<`, `==` & `in` operators. If you don't use an operator, the condition checks if the property is null." }, "true": { "type": "object", "description": "The component you want to show when your condition is true." }, "false": { "type": "object", "description": "The component you want to show when your condition is false." } } }, "actionWidget": { "x-scalar-ignore": true, "description": "An action is either a link or a way to dismiss your message. The `behaviour` property determines how your app treats the action.", "type": "object", "required": [ "type", "component", "action" ], "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "actionWidget" ] }, "action": { "type": "string", "description": "The link or place you want to send a person. This is either a deep link in your app, a web address, a `mailto` link, or a way to close the message (`gist://close`)." }, "behaviour": { "type": "string", "description": "Action behavior; `push` adds a route, `system` delegates to the OS, `back` pops one route, and `retain` replaces the current view.", "enum": [ "push", "system", "back", "retain" ] }, "component": { "type": "object", "description": "The component a person taps to perform the action defined in this widget." } } }, "fixedListWidget": { "x-scalar-ignore": true, "description": "Displays a series of components in a vertical list.", "type": "object", "properties": { "type": { "description": "Defines the widget type.", "enum": [ "fixedListWidget" ] }, "mainAxisAlignment": { "x-scalar-ignore": true, "type": "string", "description": "The mainAxisAlignment property supports the following options.", "enum": [ "start", "end", "spaceBetween", "spaceAround", "spaceEvenly" ] }, "crossAxisAlignment": { "x-scalar-ignore": true, "type": "string", "description": "The crossAxisAlignment property supports the following options", "enum": [ "center", "start", "end", "center", "stretch", "baseline" ] }, "components": { "x-scalar-ignore": true, "description": "An array of child components that you want to make available inside this widget.", "type": "array", "items": { "type": "object" } } } }, "fixedHorizontalListWidget": { "x-scalar-ignore": true, "description": "Displays a series of components in a horizontal list, like if you want to put an image and text next to each other.", "type": "object", "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "fixedHorizontalListWidget" ] }, "mainAxisAlignment": { "x-scalar-ignore": true, "type": "string", "description": "The mainAxisAlignment property supports the following options.", "enum": [ "start", "end", "spaceBetween", "spaceAround", "spaceEvenly" ] }, "crossAxisAlignment": { "x-scalar-ignore": true, "type": "string", "description": "The crossAxisAlignment property supports the following options", "enum": [ "center", "start", "end", "center", "stretch", "baseline" ] }, "components": { "x-scalar-ignore": true, "description": "An array of child components that you want to make available inside this widget.", "type": "array", "items": { "type": "object" } } } }, "fixedHorizontalScrollWidget": { "x-scalar-ignore": true, "type": "object", "description": "A series of components that you can scroll through, like a carousel.", "properties": { "type": { "type": "string", "description": "Defines the widget type", "enum": [ "fixedHorizontalListScrollWidget" ] }, "height": { "type": "integer", "description": "The height of the widget in pixels." }, "components": { "x-scalar-ignore": true, "description": "An array of child components that you want to make available inside this widget.", "type": "array", "items": { "type": "object" } } } }, "fixedGridWidget": { "x-scalar-ignore": true, "description": "Used to layout an in-app message in a fixed grid.", "type": "object", "required": [ "type", "components", "columns" ], "properties": { "type": { "type": "string", "description": "Defines the widget type.", "enum": [ "fixedGridWidget" ] }, "itemPadding": { "type": "string", "description": "The padding between items in your grid." }, "columns": { "type": "integer", "description": "The number of columns in your grid." }, "childAspectRatio": { "type": "number", "description": "The aspect ratio for items in the grid. Defaults to 1.0" }, "components": { "x-scalar-ignore": true, "description": "An array of child components that you want to make available inside this widget.", "type": "array", "items": { "type": "object" } } } }, "inAppMessageEventDetail": { "x-scalar-ignore": true, "type": "object", "description": "An object containing message specific data depending on the event type.", "properties": { "messageId": { "type": "string", "description": "Identifier string of the in-app message." }, "deliveryId": { "type": "string", "description": "Delivery Id for the corresponding in-app message (not present in test message)." } } }, "inAppMessageOpenedEvent": { "x-scalar-ignore": true, "type": "object", "description": "Event object passed to the listener function when user is shown an in-app message.", "properties": { "type": { "type": "string", "description": "Defines the event type.", "enum": [ "in-app:message-opened" ] }, "detail": { "x-scalar-ignore": true, "type": "object", "description": "An object containing message specific data depending on the event type.", "properties": { "messageId": { "type": "string", "description": "Identifier string of the in-app message." }, "deliveryId": { "type": "string", "description": "Delivery Id for the corresponding in-app message (not present in test message)." } } } } }, "inAppMessageDismissedEvent": { "x-scalar-ignore": true, "type": "object", "description": "Event object passed to the listener function when user dismisses an in-app message.", "properties": { "type": { "type": "string", "description": "Defines the event type.", "enum": [ "in-app:message-dismissed" ] }, "detail": { "x-scalar-ignore": true, "type": "object", "description": "An object containing message specific data depending on the event type.", "properties": { "messageId": { "type": "string", "description": "Identifier string of the in-app message." }, "deliveryId": { "type": "string", "description": "Delivery Id for the corresponding in-app message (not present in test message)." } } } } }, "inAppMessageActionEvent": { "x-scalar-ignore": true, "type": "object", "description": "Event object passed to the listener function when user performs an action in the in-app message.", "properties": { "type": { "type": "string", "description": "Defines the event type.", "enum": [ "in-app:message-action" ] }, "detail": { "type": "object", "properties": { "messageId": { "type": "string", "description": "Identifier string of the in-app message." }, "deliveryId": { "type": "string", "description": "Delivery Id for the corresponding in-app message (not present in test message)." }, "actionName": { "type": "string", "description": "The name of the action specified when building the in-app message." }, "actionValue": { "type": "string", "description": "The type of action that triggered the event." } } } } }, "inAppMessageErrorEvent": { "x-scalar-ignore": true, "type": "object", "description": "Event object passed to the listener function when an error occurs.", "properties": { "type": { "type": "string", "description": "Defines the event type.", "enum": [ "in-app:message-error" ] }, "detail": { "x-scalar-ignore": true, "type": "object", "description": "An object containing message specific data depending on the event type.", "properties": { "messageId": { "type": "string", "description": "Identifier string of the in-app message." }, "deliveryId": { "type": "string", "description": "Delivery Id for the corresponding in-app message (not present in test message)." } } } } }, "errors": { "x-scalar-ignore": true, "type": "array", "description": "An array of errors, where each object represents a different error.", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "The reason for the error." }, "field": { "type": "string", "description": "The field containing the error." }, "message": { "type": "string", "description": "A detailed description of the error in the offending field." } } } }, "object_operations": { "x-scalar-ignore": true, "title": "Object operations", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "identify", "attributes": { "name": "Acme Corp" } }, "oneOf": [ { "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "identify", "attributes": { "name": "Acme Corp", "plan": "enterprise", "seats": 50 } }, "type": "object", "title": "Object: Identify", "description": "The `action` determines the type of operation you want to perform with an object. If `identifiers.object_id` does not exist, we'll create a new object; if it exists, we'll update the object accordingly.\n", "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "identifiers": { "description": "Custom object identifiers. To create, provide `object_type_id` and `object_id`; to update, use those values or `cio_object_id`.", "oneOf": [ { "title": "Object ID (create and update)", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID (updates only)", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] }, "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `identify` the item of the specified `type`.", "enum": [ "identify" ] }, "attributes": { "x-scalar-ignore": true, "type": "object", "description": "Data that belongs to the object. Pass `null` or an empty string to remove an attribute. Some attributes have special meaning—see [reserved attributes](/journeys/objects-data/objects/create/#reserved-attributes)." }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } } } } ] }, { "title": "Object: Identify anonymous", "description": "The `identify_anonymous` action lets you relate an object to a person who hasn't yet identified themselves by anonymous_id. When you identify the person, their anonymous relationship will carry over to the identified profile.", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "identify_anonymous", "anonymous_id": "anon-abc-123" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "identifiers": { "description": "Custom object identifiers. To create, provide `object_type_id` and `object_id`; to update, use those values or `cio_object_id`.", "oneOf": [ { "title": "Object ID (create and update)", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID (updates only)", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] }, "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `identify` the item of the specified `type` and relate it to an `anonymous_id`.", "enum": [ "identify_anonymous" ] }, "attributes": { "x-scalar-ignore": true, "type": "object", "description": "Data that belongs to the object. Pass `null` or an empty string to remove an attribute. Some attributes have special meaning—see [reserved attributes](/journeys/objects-data/objects/create/#reserved-attributes)." }, "cio_relationships": { "type": "array", "description": "The anonymous people you want to associate with an object. Each object in the array contains an `anonymous_id` representing a person you haven't yet identified by `id` or `email`.", "items": { "type": "object", "properties": { "identifiers": { "type": "object", "properties": { "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." } } }, "relationship_attributes": { "type": "object", "description": "Coming October 2023 - The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship." } } } } } } ] }, { "title": "Object: Delete", "description": "Delete an object. This also removes relationships from people.\n", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "delete" }, "allOf": [ { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `delete` the item of the specified `type`.", "enum": [ "delete" ] } } } ] }, { "title": "Object: Add relationships", "description": "Add relationships between an object and one or more people.", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "add_relationships", "cio_relationships": [ { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin" } } ] }, "allOf": [ { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation associates an object with one or more people.", "enum": [ "add_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } } } } ] }, { "title": "Object: Delete relationships", "description": "Delete relationships between an object and one or more people.", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "delete_relationships", "cio_relationships": [ { "identifiers": { "id": "42" } } ] }, "allOf": [ { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation deletes an object relationship from one or more people.", "enum": [ "delete_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } } } } ] } ], "discriminator": { "propertyName": "action" } }, "person_operations": { "x-scalar-ignore": true, "title": "Person operations", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "identify", "attributes": { "first_name": "Jane" } }, "oneOf": [ { "title": "Person: Identify", "description": "Add or update a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "identify", "attributes": { "first_name": "Jane", "last_name": "Doe", "plan": "premium" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `identify` the item of the specified `type`.", "enum": [ "identify" ] }, "timestamp": { "type": "integer", "description": "The Unix timestamp for when the attribute update occurred. This can be used to control the order of attribute updates when multiple requests are sent in rapid succession.", "example": 1772013598 }, "attributes": { "type": "object", "description": "Attributes that you want to add or update for this person. You can pass properties that aren't defined below to set custom attributes; the defined properties are reserved in the Customer.io Track API.", "properties": { "cio_subscription_preferences": { "x-scalar-ignore": true, "description": "A person's [subscription center](/journeys/channels/subscriptions/center/) preferences. Use JSON dot notation, such as `cio_subscription_preferences.topics.topic_`, to update one topic without replacing others.", "type": "object", "properties": { "topics": { "type": "object", "description": "Contains active topics in your workspace, named `topic_`.", "additionalProperties": { "x-additionalPropertiesName": "topic_", "description": "Boolean preference for a topic named `topic_`; `true` subscribes, `false` unsubscribes, and empty or missing values use the topic default. Find topic IDs with [getTopics](/integrations/api/app/tag/subscription-center/getTopics/).", "type": "boolean" } } }, "example": { "topics": { "topic_1": true, "topic_2": false, "topic_3": true } } }, "_update": { "type": "boolean", "default": false, "description": "If `true`, update only existing people and prevent accidental profile creation. If no person matches the identifiers, the request does nothing." } }, "additionalProperties": { "x-additionalPropertiesName": "additional attributes", "description": "Custom properties that you want to set as attributes on this person." } }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } } ] }, { "title": "Person: Delete", "description": "Delete a person from your workspace.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "delete" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `delete` the item of the specified `type`.", "enum": [ "delete" ] } } } ] }, { "title": "Person: Event", "description": "A custom event attributed to a person. You can use events to trigger automations, or reference event information using liquid in your messages.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "event", "name": "purchase", "attributes": { "product": "Widget", "price": 29.99 } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "name" ], "properties": { "action": { "type": "string", "description": "A custom event attributed to the specified person.", "enum": [ "event" ] }, "id": { "type": "string", "format": "ULID", "description": "A valid ULID used to deduplicate events. Note - our Python and Ruby libraries do not pass this id." }, "name": { "type": "string", "description": "The name of the event. This is how you'll find your event in Customer.io or select it when using events as automation triggers." }, "timestamp": { "type": "integer", "description": "The Unix timestamp when the event happened." }, "attributes": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.\n", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." }, "properties": { "recipient": { "type": "string", "format": "email", "description": "The email address of the person associated with the event, overriding the `to` field in emails triggered by the event." }, "from_address": { "type": "string", "format": "email", "description": "The address you want to trigger messages from, overriding the `from` field in emails triggered by the event." }, "reply_to": { "type": "string", "format": "email", "description": "The address you want to receive replies to, overriding the `reply to` field for emails triggered by the event." } } } } } ] }, { "title": "Person: Screen view", "description": "A mobile \"screenview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "screen", "name": "Dashboard", "attributes": { "app_version": "2.1.0" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "name" ], "properties": { "action": { "type": "string", "description": "A mobile \"screenview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "enum": [ "screen" ] }, "id": { "type": "string", "format": "ULID", "description": "A valid ULID used to deduplicate events. Note - our Python and Ruby libraries do not pass this id." }, "name": { "type": "string", "description": "The name of the screen a person visited. This is how you'll find and select screen view events in Customer.io." }, "timestamp": { "type": "integer", "description": "The Unix timestamp when the event happened." }, "attributes": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." } } } } ] }, { "title": "Person: Page view", "description": "A web \"pageview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "page", "name": "/pricing", "attributes": { "referrer": "https://example.com" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "name" ], "properties": { "action": { "type": "string", "description": "A web \"pageview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "enum": [ "page" ] }, "id": { "type": "string", "format": "ULID", "description": "A valid ULID used to deduplicate events. Note - our Python and Ruby libraries do not pass this id." }, "name": { "type": "string", "description": "The name of the page or page path that a person visited. This is how you'll find and select page view events in Customer.io." }, "timestamp": { "type": "integer", "description": "The Unix timestamp when the event happened." }, "attributes": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.", "properties": { "path": { "type": "string", "description": "The path portion of the page's URL. Equivalent to the canonical `path` which defaults to `location.pathname` from the DOM API." }, "referrer": { "type": "string", "description": "The previous page's full URL. Equivalent to `document.referrer` from the DOM API." }, "search": { "type": "string", "description": "The query string portion of the page's URL. Equivalent to `location.search` from the DOM API." }, "title": { "type": "string", "description": "The page's title. Equivalent to `document.title` from the DOM API." }, "url": { "type": "string", "description": "A page's full URL. We first look for the canonical URL. If the canonical URL is not provided, we'll use `location.href` from the DOM API." }, "keywords": { "type": "array", "description": "Page-content keywords, typically like HTML meta keywords. Mainly for publishers with pageview tracking; not collected automatically.", "items": { "type": "string" } } }, "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." } } } } ] }, { "title": "Person: Add relationships", "description": "Associate multiple objects with a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "add_relationships", "cio_relationships": [ { "identifiers": { "object_type_id": "1", "object_id": "acme" }, "relationship_attributes": { "role": "admin" } } ] }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation associates a person with one or more objects.", "enum": [ "add_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } } ] }, { "title": "Person: Delete relationships", "description": "Remove multiple object relationships from a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "delete_relationships", "cio_relationships": [ { "identifiers": { "object_type_id": "1", "object_id": "acme" } } ] }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation deletes an object relationship from one or more people.", "enum": [ "delete_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } } ] }, { "title": "Person: Add device", "description": "Assign devices to a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "add_device", "device": { "token": "a83b219c-e756-4c5b-a8e3-d1a5c5b2f3c1", "platform": "ios", "last_used": 1713484800 } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "device" ], "properties": { "action": { "type": "string", "description": "Add a mobile device to a person's profile.", "enum": [ "add_device" ] }, "device": { "description": "Device properties collected by [Customer.io SDKs](/integrations/sdk/) unless `autoTrackDeviceAttributes` is disabled. You can reference them outside `attributes` in segments.", "allOf": [ { "type": "object", "required": [ "token" ], "properties": { "token": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] } } } ] }, { "title": "Person: Delete device", "description": "Delete devices that belong to a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "delete_device", "device": { "token": "a83b219c-e756-4c5b-a8e3-d1a5c5b2f3c1" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "device" ], "properties": { "action": { "type": "string", "description": "Delete a device from a person's profile.", "enum": [ "delete_device" ] }, "device": { "description": "The device you want to remove.", "type": "object", "required": [ "token" ], "properties": { "token": { "description": "The token of the device you want to remove.", "type": "string" } } } } } ] }, { "title": "Person: Merge", "example": { "primary": { "id": "42" }, "secondary": { "id": "known-user-456" } }, "type": "object", "description": "Merges `secondary` into `primary`, then deletes `secondary`. The operation is not reversible, and `primary` must already exist. See [merging duplicate people](/journeys/people/manage/merge-people/).", "required": [ "type", "primary", "secondary", "action" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "action": { "type": "string", "description": "Merges `secondary` into `primary`, then deletes `secondary`. Not reversible; see [merging duplicate people](/journeys/people/manage/merge-people/).", "enum": [ "merge" ] }, "primary": { "description": "The person who remains after the merge, identified by `id`, `email`, or `cio_id`. If email identifiers are disabled in [workspace settings](https://fly.customer.io/workspaces/last/settings/edit), use `id` or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "secondary": { "description": "The person deleted after the merge, identified by `id`, `email`, or `cio_id`. If email identifiers are disabled in [workspace settings](https://fly.customer.io/workspaces/last/settings/edit), use `id` or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "title": "Person: Suppress", "description": "Suppress a person's identifier(s) in Customer.io, so that you can't message a person or add their identifiers back to your workspace. This is separate from suppressions performed by your email provider.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "suppress" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Suppress a person's identifier(s) in Customer.io, so that you can't message a person or add their identifiers back to your workspace. This is separate from suppressions performed by your email provider.", "enum": [ "suppress" ] } } } ] }, { "title": "Person: Unsuppress", "description": "Unsuppress a person's identifier(s) in Customer.io, so that you can message a person or add their identifiers back to your workspace. This does not unsuppress addresses that were previously suppressed by your email provider.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "unsuppress" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Unsuppress a person's identifier(s) in Customer.io, so that you can message a person or add their identifiers back to your workspace. This does not unsuppress addresses that were previously suppressed by your email provider.", "enum": [ "unsuppress" ] } } } ] } ], "discriminator": { "propertyName": "action" } }, "person_common": { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, "person_attributes": { "x-scalar-ignore": true, "type": "object", "description": "Attributes that you want to add or update for this person.", "properties": { "cio_subscription_preferences": { "x-scalar-ignore": true, "description": "A person's [subscription center](/journeys/channels/subscriptions/center/) preferences. Use JSON dot notation, such as `cio_subscription_preferences.topics.topic_`, to update one topic without replacing others.", "type": "object", "properties": { "topics": { "type": "object", "description": "Contains active topics in your workspace, named `topic_`.", "additionalProperties": { "x-additionalPropertiesName": "topic_", "description": "Boolean preference for a topic named `topic_`; `true` subscribes, `false` unsubscribes, and empty or missing values use the topic default. Find topic IDs with [getTopics](/integrations/api/app/tag/subscription-center/getTopics/).", "type": "boolean" } } }, "example": { "topics": { "topic_1": true, "topic_2": false, "topic_3": true } } } } }, "object_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } }, "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } }, "object_attributes": { "x-scalar-ignore": true, "type": "object", "description": "Data that belongs to the object. Pass `null` or an empty string to remove an attribute. Some attributes have special meaning—see [reserved attributes](/journeys/objects-data/objects/create/#reserved-attributes)." }, "object_common_identify": { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "identifiers": { "description": "Custom object identifiers. To create, provide `object_type_id` and `object_id`; to update, use those values or `cio_object_id`.", "oneOf": [ { "title": "Object ID (create and update)", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID (updates only)", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] }, "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } }, "object_common": { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, "v2_cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } }, "v1_cio_relationships": { "x-scalar-ignore": true, "type": "object", "description": "Describes relationships to an entity—a non-person object in Customer.io, like a company, educational course, job board, etc.", "properties": { "action": { "type": "string", "description": "This determines whether the `relationships` array adds relationships to a person or removes them from a person.", "enum": [ "add_relationships", "delete_relationships" ] }, "relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } }, "track-metrics": { "x-scalar-ignore": true, "description": "The base properties shared across multiple metric types.", "type": "object", "required": [ "delivery_id" ], "properties": { "delivery_id": { "type": "string", "description": "The CIO-Delivery-ID from the notification that you want to associate the `event` with.", "example": "RPILAgUBcRhIBqSfeiIwdIYJKxTY" }, "timestamp": { "type": "integer", "format": "unix timestamp", "description": "The unix timestamp when the event occurred.", "example": 1613063089 } } }, "object_identify": { "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "identify", "attributes": { "name": "Acme Corp", "plan": "enterprise", "seats": 50 } }, "type": "object", "title": "Object: Identify", "description": "The `action` determines the type of operation you want to perform with an object. If `identifiers.object_id` does not exist, we'll create a new object; if it exists, we'll update the object accordingly.\n", "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "identifiers": { "description": "Custom object identifiers. To create, provide `object_type_id` and `object_id`; to update, use those values or `cio_object_id`.", "oneOf": [ { "title": "Object ID (create and update)", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID (updates only)", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] }, "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `identify` the item of the specified `type`.", "enum": [ "identify" ] }, "attributes": { "x-scalar-ignore": true, "type": "object", "description": "Data that belongs to the object. Pass `null` or an empty string to remove an attribute. Some attributes have special meaning—see [reserved attributes](/journeys/objects-data/objects/create/#reserved-attributes)." }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } } } } ] }, "object_identify_anonymous": { "title": "Object: Identify anonymous", "description": "The `identify_anonymous` action lets you relate an object to a person who hasn't yet identified themselves by anonymous_id. When you identify the person, their anonymous relationship will carry over to the identified profile.", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "identify_anonymous", "anonymous_id": "anon-abc-123" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "identifiers": { "description": "Custom object identifiers. To create, provide `object_type_id` and `object_id`; to update, use those values or `cio_object_id`.", "oneOf": [ { "title": "Object ID (create and update)", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID (updates only)", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] }, "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `identify` the item of the specified `type` and relate it to an `anonymous_id`.", "enum": [ "identify_anonymous" ] }, "attributes": { "x-scalar-ignore": true, "type": "object", "description": "Data that belongs to the object. Pass `null` or an empty string to remove an attribute. Some attributes have special meaning—see [reserved attributes](/journeys/objects-data/objects/create/#reserved-attributes)." }, "cio_relationships": { "type": "array", "description": "The anonymous people you want to associate with an object. Each object in the array contains an `anonymous_id` representing a person you haven't yet identified by `id` or `email`.", "items": { "type": "object", "properties": { "identifiers": { "type": "object", "properties": { "anonymous_id": { "x-scalar-ignore": true, "type": "string", "description": "An identifier for an anonymous event, like a cookie. If set as an attribute on a person, any events bearing the same anonymous value are associated with this person. This value must be unique and is not reusable." } } }, "relationship_attributes": { "type": "object", "description": "Coming October 2023 - The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship." } } } } } } ] }, "object_add_relationships": { "title": "Object: Add relationships", "description": "Add relationships between an object and one or more people.", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "add_relationships", "cio_relationships": [ { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin" } } ] }, "allOf": [ { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation associates an object with one or more people.", "enum": [ "add_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } } } } ] }, "object_delete_relationships": { "title": "Object: Delete relationships", "description": "Delete relationships between an object and one or more people.", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "delete_relationships", "cio_relationships": [ { "identifiers": { "id": "42" } } ] }, "allOf": [ { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation deletes an object relationship from one or more people.", "enum": [ "delete_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "The people you want to associate with an object. Each object in the array represents a person.", "items": { "type": "object", "properties": { "identifiers": { "oneOf": [ { "title": "id", "type": "object", "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "relationship_attributes": { "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" } } }, "example": { "identifiers": { "id": "42" }, "relationship_attributes": { "role": "admin", "date_created": 1702480414 } } } } } } ] }, "object_delete": { "title": "Object: Delete", "description": "Delete an object. This also removes relationships from people.\n", "example": { "type": "object", "identifiers": { "object_type_id": "1", "object_id": "acme" }, "action": "delete" }, "allOf": [ { "x-scalar-ignore": true, "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The operation modifies a single object—non person data.", "type": "string", "enum": [ "object" ] } } } ] }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `delete` the item of the specified `type`.", "enum": [ "delete" ] } } } ] }, "identify_person": { "title": "Person: Identify", "description": "Add or update a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "identify", "attributes": { "first_name": "Jane", "last_name": "Doe", "plan": "premium" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `identify` the item of the specified `type`.", "enum": [ "identify" ] }, "timestamp": { "type": "integer", "description": "The Unix timestamp for when the attribute update occurred. This can be used to control the order of attribute updates when multiple requests are sent in rapid succession.", "example": 1772013598 }, "attributes": { "type": "object", "description": "Attributes that you want to add or update for this person. You can pass properties that aren't defined below to set custom attributes; the defined properties are reserved in the Customer.io Track API.", "properties": { "cio_subscription_preferences": { "x-scalar-ignore": true, "description": "A person's [subscription center](/journeys/channels/subscriptions/center/) preferences. Use JSON dot notation, such as `cio_subscription_preferences.topics.topic_`, to update one topic without replacing others.", "type": "object", "properties": { "topics": { "type": "object", "description": "Contains active topics in your workspace, named `topic_`.", "additionalProperties": { "x-additionalPropertiesName": "topic_", "description": "Boolean preference for a topic named `topic_`; `true` subscribes, `false` unsubscribes, and empty or missing values use the topic default. Find topic IDs with [getTopics](/integrations/api/app/tag/subscription-center/getTopics/).", "type": "boolean" } } }, "example": { "topics": { "topic_1": true, "topic_2": false, "topic_3": true } } }, "_update": { "type": "boolean", "default": false, "description": "If `true`, update only existing people and prevent accidental profile creation. If no person matches the identifiers, the request does nothing." } }, "additionalProperties": { "x-additionalPropertiesName": "additional attributes", "description": "Custom properties that you want to set as attributes on this person." } }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } } ] }, "person_delete": { "title": "Person: Delete", "description": "Delete a person from your workspace.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "delete" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Indicates that the operation will `delete` the item of the specified `type`.", "enum": [ "delete" ] } } } ] }, "person_event": { "title": "Person: Event", "description": "A custom event attributed to a person. You can use events to trigger automations, or reference event information using liquid in your messages.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "event", "name": "purchase", "attributes": { "product": "Widget", "price": 29.99 } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "name" ], "properties": { "action": { "type": "string", "description": "A custom event attributed to the specified person.", "enum": [ "event" ] }, "id": { "type": "string", "format": "ULID", "description": "A valid ULID used to deduplicate events. Note - our Python and Ruby libraries do not pass this id." }, "name": { "type": "string", "description": "The name of the event. This is how you'll find your event in Customer.io or select it when using events as automation triggers." }, "timestamp": { "type": "integer", "description": "The Unix timestamp when the event happened." }, "attributes": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.\n", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." }, "properties": { "recipient": { "type": "string", "format": "email", "description": "The email address of the person associated with the event, overriding the `to` field in emails triggered by the event." }, "from_address": { "type": "string", "format": "email", "description": "The address you want to trigger messages from, overriding the `from` field in emails triggered by the event." }, "reply_to": { "type": "string", "format": "email", "description": "The address you want to receive replies to, overriding the `reply to` field for emails triggered by the event." } } } } } ] }, "person_page": { "title": "Person: Page view", "description": "A web \"pageview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "page", "name": "/pricing", "attributes": { "referrer": "https://example.com" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "name" ], "properties": { "action": { "type": "string", "description": "A web \"pageview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "enum": [ "page" ] }, "id": { "type": "string", "format": "ULID", "description": "A valid ULID used to deduplicate events. Note - our Python and Ruby libraries do not pass this id." }, "name": { "type": "string", "description": "The name of the page or page path that a person visited. This is how you'll find and select page view events in Customer.io." }, "timestamp": { "type": "integer", "description": "The Unix timestamp when the event happened." }, "attributes": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.", "properties": { "path": { "type": "string", "description": "The path portion of the page's URL. Equivalent to the canonical `path` which defaults to `location.pathname` from the DOM API." }, "referrer": { "type": "string", "description": "The previous page's full URL. Equivalent to `document.referrer` from the DOM API." }, "search": { "type": "string", "description": "The query string portion of the page's URL. Equivalent to `location.search` from the DOM API." }, "title": { "type": "string", "description": "The page's title. Equivalent to `document.title` from the DOM API." }, "url": { "type": "string", "description": "A page's full URL. We first look for the canonical URL. If the canonical URL is not provided, we'll use `location.href` from the DOM API." }, "keywords": { "type": "array", "description": "Page-content keywords, typically like HTML meta keywords. Mainly for publishers with pageview tracking; not collected automatically.", "items": { "type": "string" } } }, "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." } } } } ] }, "person_screen": { "title": "Person: Screen view", "description": "A mobile \"screenview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "screen", "name": "Dashboard", "attributes": { "app_version": "2.1.0" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "name" ], "properties": { "action": { "type": "string", "description": "A mobile \"screenview\" event attributed to a person. Our `screen` and `page` event types are more specific than our standard `event`, and help you track and target people based on the pages people visit in your mobile app or website.", "enum": [ "screen" ] }, "id": { "type": "string", "format": "ULID", "description": "A valid ULID used to deduplicate events. Note - our Python and Ruby libraries do not pass this id." }, "name": { "type": "string", "description": "The name of the screen a person visited. This is how you'll find and select screen view events in Customer.io." }, "timestamp": { "type": "integer", "description": "The Unix timestamp when the event happened." }, "attributes": { "type": "object", "description": "Additional information that you might want to reference in a message using liquid or use to set attributes on the identified person.", "additionalProperties": { "x-additionalPropertiesName": "liquid merge data", "description": "Insert key-values that you want to reference in your message here." } } } } ] }, "person_add_relationships": { "title": "Person: Add relationships", "description": "Associate multiple objects with a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "add_relationships", "cio_relationships": [ { "identifiers": { "object_type_id": "1", "object_id": "acme" }, "relationship_attributes": { "role": "admin" } } ] }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation associates a person with one or more objects.", "enum": [ "add_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } } ] }, "person_delete_relationships": { "title": "Person: Delete relationships", "description": "Remove multiple object relationships from a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "delete_relationships", "cio_relationships": [ { "identifiers": { "object_type_id": "1", "object_id": "acme" } } ] }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "cio_relationships" ], "properties": { "action": { "type": "string", "description": "This operation deletes an object relationship from one or more people.", "enum": [ "delete_relationships" ] }, "cio_relationships": { "x-scalar-ignore": true, "type": "array", "description": "Each object in the array represents a relationship you want to add to, or remove from, a person.", "items": { "allOf": [ { "x-scalar-ignore": true, "type": "object", "properties": { "identifiers": { "description": "The identifiers for a particular object. You can use either the `object_type_id` and `object_id` (where `object_type_id` represents the type of object and the `object_id` is the individual identifier for the object) or the `cio_object_id`.", "oneOf": [ { "title": "Object ID", "type": "object", "required": [ "object_type_id", "object_id" ], "properties": { "object_type_id": { "x-scalar-ignore": true, "type": "string", "description": "The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs are string-formatted integers that begin at `1` and increment for each new type.", "example": "1" }, "object_id": { "type": "string", "description": "The unique identifier for an object. If you use an `object_id` that already exists, we'll update the object accordingly.", "example": "acme" } } }, { "title": "CIO Object ID", "type": "object", "required": [ "cio_object_id" ], "properties": { "cio_object_id": { "type": "string", "description": "A unique value that Customer.io sets for an object when you create it. This ID is immutable.", "example": "obb7fd050101" } } } ] } } }, { "type": "object", "properties": { "relationship_attributes": { "x-scalar-ignore": true, "type": "object", "description": "The attributes associated with a relationship. Passing null or an empty string removes the attribute from the relationship.\n", "additionalProperties": { "x-additionalPropertiesName": "Relationship Attributes" }, "example": { "role": "admin" } } } } ] } } } } ] }, "person_add_device": { "title": "Person: Add device", "description": "Assign devices to a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "add_device", "device": { "token": "a83b219c-e756-4c5b-a8e3-d1a5c5b2f3c1", "platform": "ios", "last_used": 1713484800 } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "device" ], "properties": { "action": { "type": "string", "description": "Add a mobile device to a person's profile.", "enum": [ "add_device" ] }, "device": { "description": "Device properties collected by [Customer.io SDKs](/integrations/sdk/) unless `autoTrackDeviceAttributes` is disabled. You can reference them outside `attributes` in segments.", "allOf": [ { "type": "object", "required": [ "token" ], "properties": { "token": { "description": "The device token.", "type": "string" } } }, { "x-scalar-ignore": true, "type": "object", "description": "Device information common to the v1 and v2 APIs.", "required": [ "platform" ], "properties": { "last_used": { "type": "integer", "format": "unix timestamp", "description": "The `timestamp` when you last identified this device. If you don't pass a timestamp when you add or update a device, we use the time of the request itself. Our SDKs identify a device when a person launches their app." }, "platform": { "type": "string", "enum": [ "ios", "android" ], "description": "The device/messaging platform." }, "attributes": { "type": "object", "description": "Attributes that you can reference to segment your audience—like a person's attributes, but specific to a device. These can be either the attributes defined below or custom key-value attributes.", "properties": { "device_os": { "type": "string", "description": "The operating system, including the version, on the device." }, "device_model": { "type": "string", "description": "The model of the device a person uses." }, "app_version": { "type": "string", "description": "The version of your app that a customer uses. You might target app versions to let people know when they need to update, or expose them to new features when they do." }, "app_identifier": { "type": "string", "description": "The app that the device belongs to—the **Bundle ID / App identifier** you entered with that app's push credentials. If you have more than one app, we use this attribute to send push notifications to the right app. A device without an app identifier receives push notifications you send to your [default app](/messaging/channels/push/getting-started/#the-default-app)." }, "cio_sdk_version": { "type": "string", "description": "The version of the Customer.io SDK in the app." }, "_last_status": { "type": "string", "readOnly": true, "description": "The delivery status of the last message sent to the device—sent, bounced, or suppressed. An empty string indicates that that the device hasn't received a push yet.", "enum": [ "", "bounced", "sent", "suppressed" ] }, "device_locale": { "type": "string", "description": "The device's [IETF language code](/journeys/channels/localization/getting-started/#supported-languages), such as `en-MX` or `es-ES`." }, "push_enabled": { "type": "string", "description": "If `\"true\"`, the device is opted-in and can receive push notifications.", "enum": [ "true", "false" ] } }, "additionalProperties": { "x-additionalPropertiesName": "Custom Device Attributes", "description": "Custom properties that you want to associate with the device.", "type": "string" } } } } ] } } } ] }, "person_delete_device": { "title": "Person: Delete device", "description": "Delete devices that belong to a person.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "delete_device", "device": { "token": "a83b219c-e756-4c5b-a8e3-d1a5c5b2f3c1" } }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action", "device" ], "properties": { "action": { "type": "string", "description": "Delete a device from a person's profile.", "enum": [ "delete_device" ] }, "device": { "description": "The device you want to remove.", "type": "object", "required": [ "token" ], "properties": { "token": { "description": "The token of the device you want to remove.", "type": "string" } } } } } ] }, "person_merge": { "title": "Person: Merge", "example": { "primary": { "id": "42" }, "secondary": { "id": "known-user-456" } }, "type": "object", "description": "Merges `secondary` into `primary`, then deletes `secondary`. The operation is not reversible, and `primary` must already exist. See [merging duplicate people](/journeys/people/manage/merge-people/).", "required": [ "type", "primary", "secondary", "action" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "action": { "type": "string", "description": "Merges `secondary` into `primary`, then deletes `secondary`. Not reversible; see [merging duplicate people](/journeys/people/manage/merge-people/).", "enum": [ "merge" ] }, "primary": { "description": "The person who remains after the merge, identified by `id`, `email`, or `cio_id`. If email identifiers are disabled in [workspace settings](https://fly.customer.io/workspaces/last/settings/edit), use `id` or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] }, "secondary": { "description": "The person deleted after the merge, identified by `id`, `email`, or `cio_id`. If email identifiers are disabled in [workspace settings](https://fly.customer.io/workspaces/last/settings/edit), use `id` or `cio_id`.", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, "person_suppress": { "title": "Person: Suppress", "description": "Suppress a person's identifier(s) in Customer.io, so that you can't message a person or add their identifiers back to your workspace. This is separate from suppressions performed by your email provider.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "suppress" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Suppress a person's identifier(s) in Customer.io, so that you can't message a person or add their identifiers back to your workspace. This is separate from suppressions performed by your email provider.", "enum": [ "suppress" ] } } } ] }, "person_unsuppress": { "title": "Person: Unsuppress", "description": "Unsuppress a person's identifier(s) in Customer.io, so that you can message a person or add their identifiers back to your workspace. This does not unsuppress addresses that were previously suppressed by your email provider.", "example": { "type": "person", "identifiers": { "id": "42" }, "action": "unsuppress" }, "allOf": [ { "x-scalar-ignore": true, "type": "object", "required": [ "type", "identifiers" ], "properties": { "type": { "description": "The operation modifies a person in Customer.io", "type": "string", "enum": [ "person" ] }, "identifiers": { "description": "The person you want to perform an action for—one of `id`, `email`, `phone`, or `cio_id`. You cannot pass multiple identifiers. You can use `email` and `phone` only if they're enabled as identifiers in your [workspace settings](/accounts/workspaces/overview/#migrate-workspace).", "oneOf": [ { "title": "id", "type": "object", "required": [ "id" ], "properties": { "id": { "x-scalar-ignore": true, "type": "string", "description": "The ID of a customer profile, analogous to a \"person\" in the UI.", "example": "42" } } }, { "title": "email", "type": "object", "required": [ "email" ], "properties": { "email": { "x-scalar-ignore": true, "type": "string", "description": "The email address of the customer.", "example": "test@example.com" } } }, { "title": "phone", "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "A person's phone number, in [E.164 format](https://en.wikipedia.org/wiki/E.164) (a leading `+` followed by up to 15 digits). Available only when `phone` is enabled as an identifier in your workspace.", "example": "+14155552671" } } }, { "title": "cio_id", "type": "object", "required": [ "cio_id" ], "properties": { "cio_id": { "x-scalar-ignore": true, "type": "string", "description": "A unique identifier set by Customer.io, used to reference a person if you want to update their identifiers.", "example": "a3000001" } } } ] } } }, { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Unsuppress a person's identifier(s) in Customer.io, so that you can message a person or add their identifiers back to your workspace. This does not unsuppress addresses that were previously suppressed by your email provider.", "enum": [ "unsuppress" ] } } } ] }, "delivery_operations": { "title": "Delivery: Event", "description": "The \"delivery\" type lets you attribute metrics to messages that don't self-report back to Customer.io, like push and in-app notifications.", "example": { "type": "delivery", "identifiers": { "id": "RPIyMTM6OjEyMzQ=" }, "action": "event", "name": "opened", "attributes": { "device_token": "a83b219c-e756-4c5b-a8e3-d1a5c5b2f3c1" } }, "type": "object", "required": [ "type", "action", "identifiers", "name", "attributes" ], "properties": { "type": { "type": "string", "description": "The \"delivery\" type lets you attribute metrics to messages that don't self-report back to Customer.io, like push and in-app notifications.", "enum": [ "delivery" ] }, "action": { "type": "string", "description": "An `event` action indicates a delivery event. Use the `name` to determine the specific metric that you want to attribute to this delivery.", "enum": [ "event" ] }, "identifiers": { "type": "object", "description": "Contains identifiers for the delivery itself.", "properties": { "id": { "type": "string", "description": "The `delivery_id` for the delivery that you want to attribute metrics to." } } }, "name": { "type": "string", "description": "The name of the metric you want to attribute to this \"delivery\".", "enum": [ "opened", "converted", "delivered" ] }, "attributes": { "type": "object", "required": [ "device_token" ], "description": "Contains information about the delivery and the individual who received the message.", "properties": { "device_token": { "type": "string", "description": "The device that received the message." } } } } }, "cio_subscription_preferences": { "x-scalar-ignore": true, "description": "A person's [subscription center](/journeys/channels/subscriptions/center/) preferences. Use JSON dot notation, such as `cio_subscription_preferences.topics.topic_`, to update one topic without replacing others.", "type": "object", "properties": { "topics": { "type": "object", "description": "Contains active topics in your workspace, named `topic_`.", "additionalProperties": { "x-additionalPropertiesName": "topic_", "description": "Boolean preference for a topic named `topic_`; `true` subscribes, `false` unsubscribes, and empty or missing values use the topic default. Find topic IDs with [getTopics](/integrations/api/app/tag/subscription-center/getTopics/).", "type": "boolean" } } }, "example": { "topics": { "topic_1": true, "topic_2": false, "topic_3": true } } }, "workspace": { "x-scalar-ignore": true, "description": "Contains workspace properties including the count of messages, people, and objects. Customer.io caches these counts, so your data may be up to two hours old.", "type": "object", "properties": { "id": { "type": "integer", "description": "The id of the workspace.", "example": "13XXXX" }, "name": { "type": "string", "description": "The name of the workspace.", "example": "Workspace 1" }, "messages_sent": { "type": "integer", "description": "The count of [messages sent](/journeys/channels/message-statuses/#sent) via any channel (email, SMS, in-app, push, slack) in the current billing period.", "example": 100202 }, "billable_messages_sent": { "type": "integer", "description": "The count of [emails sent](/journeys/channels/message-statuses/#sent) that are considered for billing in your current billing period. Ultimately, we only bill for the overages on your plan.", "example": 75124 }, "people": { "type": "integer", "description": "The current count of people profiles in the workspace. Updates roughly every hour.", "example": 25666 }, "object_types": { "type": "integer", "description": "The current count of object types in the workspace. Updates roughly every hour.", "example": 4 }, "objects": { "type": "integer", "description": "The current count of object profiles in the workspace. Updates roughly every hour.", "example": 10 } } }, "campaign_actions": { "x-scalar-ignore": true, "type": "array", "description": "An array of actions contained within the automation.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The action type.", "example": "email" }, "id": { "type": "integer", "description": "The identifier for the action.", "example": 259 } } } }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_description": { "x-scalar-ignore": true, "type": "string", "description": "The description of the automation, if one was set.", "example": "Sends a welcome series to new trial signups." }, "active": { "x-scalar-ignore": true, "type": "boolean", "description": "If true, the automation is active and can still send messages." }, "state": { "x-scalar-ignore": true, "type": "string", "description": "The status of the automation.", "enum": [ "running", "draft", "stopped" ] }, "first_started": { "x-scalar-ignore": true, "type": "integer", "format": "unix timestamp", "description": "The date and time when you first started the automation and it first became eligible to be triggered.", "example": 1552341937 }, "tags": { "x-scalar-ignore": true, "type": "array", "description": "An array of tags you set on this automation.", "items": { "type": "string" }, "example": [ "new", "welcome" ] }, "filter_segment_ids": { "x-scalar-ignore": true, "description": "A list of segments used in the automation filter, returned if the automation audience was filtered on one or more segments.", "type": "array", "items": { "type": "integer" }, "example": [ 21, 42 ] }, "object_type_id_trigger": { "x-scalar-ignore": true, "description": "The object type ID of the trigger.", "type": "integer" }, "filter_object_attributes": { "x-scalar-ignore": true, "description": "A list of object attributes used in the automation filter, returned if the automation audience was filtered on one or more object attributes.", "type": "string", "example": "{\"and\":[{\"object_attribute\":{\"type_id\":1,\"field\":\"name\",\"operator\":\"eq\",\"value\":\"sfa\"}},{\"object_attribute\":{\"type_id\":1,\"field\":\"renewal_date\",\"operator\":\"eq\",\"value\":\"sdfs\"}}]}" }, "filter_relationship_attributes": { "x-scalar-ignore": true, "description": "A list of relationship attributes used in the automation filter, returned if the automation audience was filtered on one or more relationship attributes.", "type": "string", "example": "{\"and\":[{\"relationship_attribute\":{\"type_id\":1,\"field\":\"email\",\"operator\":\"eq\",\"value\":\"dscs@test.com\"}},{\"relationship_attribute\":{\"type_id\":1,\"field\":\"trig\",\"operator\":\"eq\",\"value\":\"false\"}}]}" }, "appApiError": { "type": "object", "description": "An array/list of failures where each entry is a separate failure reason.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "description": "One entry for each reason the request failed.", "items": { "type": "object", "required": [ "detail", "status" ], "properties": { "detail": { "type": "string", "description": "What went wrong, in plain text. Most messages end with a support reference you can use if you need to contact support.", "example": "bad request (reference a1b2c3)" }, "status": { "type": "string", "description": "The HTTP status code as a string.", "example": "400" }, "code": { "type": "string", "description": "A stable identifier for the failure, on the errors that carry one. Use this rather than the text in `detail` if you need to identify the error programmatically.", "example": "invalid_credentials" }, "source": { "type": "object", "description": "The part of the request that the error refers to.", "properties": { "pointer": { "type": "string", "description": "A JSON pointer to the part of the request body that the error refers to.", "example": "/data/attributes/email" } } }, "meta": { "type": "object", "additionalProperties": true, "description": "Extra context (if available)." } } } } } }, "reporting_webhook": { "x-scalar-ignore": true, "oneOf": [ { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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.\n\nSome fields in the `data` object change based on whether the message that resulted in the change originated from a broadcast, automation, or newsletter.\n", "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](/integrations/api/app/tag/subscription-center/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } ] } } } ] }, { "x-scalar-ignore": true, "title": "Email", "description": "Events representing an email.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient", "subject" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, { "title": "Push", "x-scalar-ignore": true, "description": "Events representing a push notification.", "oneOf": [ { "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": [ "drafted" ], "description": "A push notification was drafted." }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "type": "object", "required": [ "recipients" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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." } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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." } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, { "x-scalar-ignore": true, "title": "In-App Messages", "description": "Events pertaining to in-app messages.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, { "x-scalar-ignore": true, "title": "SMS", "description": "Events pertaining to SMS notifications.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The MSISDN (phone number) of the SMS recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The MSISDN (phone number) of the SMS recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The phone number of the person who sent the reply." } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, { "x-scalar-ignore": true, "title": "Slack", "description": "Events pertaining to Slack messages.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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`." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, { "x-scalar-ignore": true, "title": "Webhook", "description": "Events pertaining to webhooks.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, { "x-scalar-ignore": true, "title": "WhatsApp", "description": "Events pertaining to WhatsApp messages.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The phone number of the WhatsApp recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The phone number of the WhatsApp recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The phone number of the WhatsApp recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The phone number of the person who sent the reply." } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } } ], "discriminator": { "propertyName": "object_type" } }, "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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.\n\nSome fields in the `data` object change based on whether the message that resulted in the change originated from a broadcast, automation, or newsletter.\n", "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](/integrations/api/app/tag/subscription-center/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } ] } } } ] }, "customer_event_common": { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } } } } } }, "person_subscribed": { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } } } } } } ] }, "person_unsubscribed": { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } } } } } } ] }, "person_cio_subscription_preferences_common": { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, "person_cio_subscription_preferences_changed": { "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.\n\nSome fields in the `data` object change based on whether the message that resulted in the change originated from a broadcast, automation, or newsletter.\n", "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](/integrations/api/app/tag/subscription-center/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation and has a parent (like a randomized split, etc).", "example": 1, "readOnly": true }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } ] } } }, "email_event": { "x-scalar-ignore": true, "title": "Email", "description": "Events representing an email.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient", "subject" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, "email_event_common": { "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 } } }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient", "subject" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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": [ { "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": [ "drafted" ], "description": "A push notification was drafted." }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "type": "object", "required": [ "recipients" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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." } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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." } } } } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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!" } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, "push_event_common": { "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 } } }, "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": [ "drafted" ], "description": "A push notification was drafted." }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "type": "object", "required": [ "recipients" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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" ] } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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." } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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." } } } } } } ] } } } ] }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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_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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "x-scalar-ignore": true, "type": "object", "properties": { "app_id": { "type": "integer", "description": "The ID of the app that the push was sent to. Useful when your workspace has more than one app.", "example": 5 }, "related_delivery_ids": { "type": "array", "items": { "type": "string" }, "description": "When a push matches multiple devices for a person, we create an individual delivery for each device. These are the IDs of the other deliveries created for the same push; the list doesn't include this event's own `delivery_id`." } } }, { "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_event": { "x-scalar-ignore": true, "title": "SMS", "description": "Events pertaining to SMS notifications.", "oneOf": [ { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "variables": { "x-scalar-ignore": true, "type": "object", "additionalProperties": true, "description": "User-defined variables associated with the message, as key-value pairs. 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 delivery has variables." }, "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The MSISDN (phone number) of the SMS recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The MSISDN (phone number) of the SMS recipient." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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." } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "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!" } } } ] } } } ] }, { "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "newsletter_name": { "type": "string", "description": "The name of the newsletter. Omitted when the name isn't available—for example, if the newsletter was deleted." }, "newsletter_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the newsletter, as an array of tag names. Omitted when the newsletter has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } } ] }, { "type": "object", "required": [ "recipient" ], "properties": { "recipient": { "type": "string", "description": "The phone number of the person who sent the reply." } } } ] } } } ] } ], "discriminator": { "propertyName": "metric" } }, "sms_event_common": { "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 } } }, "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](/integrations/api/app/tag/send-messages/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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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" } } }, "broadcast_name": { "type": "string", "description": "The name of the broadcast. Omitted when the name isn't available—for example, if the broadcast was deleted." }, "broadcast_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the broadcast, as an array of tag names. Omitted when the broadcast has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "title": "Campaign", "type": "object", "required": [ "campaign_id", "delivery_id", "action_id", "identifiers" ], "properties": { "campaign_id": { "oneOf": [ { "x-scalar-ignore": true, "description": "The identifier for an automation.", "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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 an automation 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 enabled in your workspace, even if they aren't set for the person. If your workspace supports multiple identifiers, this object contains `cio_id` plus each enabled identifier—`id`, `email`, and (if enabled) `phone`. Each of these can be null when the person doesn't have that identifier set.\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" }, "phone": { "type": [ "string", "null" ], "description": "The person's phone number. This key only appears if your workspace has phone enabled as an identifier.", "example": "+15558675309" }, "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 an automation 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 automation (not an API-triggered broadcast).", "example": "21E4C3CT6YDC7Y4N7FE1GWWABC" }, "campaign_name": { "x-scalar-ignore": true, "type": "string", "description": "The name of the automation.", "readOnly": true }, "campaign_tags": { "type": "array", "items": { "type": "string" }, "description": "The tags on the automation, as an array of tag names. Omitted when the automation has no tags or the tags aren't available." }, "template_id": { "x-scalar-ignore": true, "type": "integer", "description": "The ID of the template used to render the message. A message's content can change over its lifetime; this is the template used for this delivery. For one-time sends (newsletters), this matches `content_id`.", "example": 3 } } }, { "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.\n\nWhile webhooks may still contain this property, you should rely on the newer `identifiers` object wherever possible.\n", "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": {