Sending Conversion Events to Snapchat via the API

This guide shows you how to build an unattended integration that uploads conversion events to Narrative and sends them to a Snap Pixel through Snapchat’s Conversions API. The examples send offline events, such as in-store purchases. Before you start, complete the prerequisites and set up API access. You need a profile ID and the ID of a Snap Pixel your Snapchat organization owns.

1. Create the dataset

A conversion-event dataset needs two columns:

snapchat_conversion_event, an object holding the event
at least one identifier Snapchat can match on, such as sha256_hashed_email

curl -X POST https://api.narrative.io/datasets \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "store_purchases_snapchat",
    "display_name": "Store Purchases (Snapchat)",
    "description": "Offline purchases for Snapchat",
    "write_mode": "append",
    "schema": {
      "file_config": { "type": "json", "normalize_field_names": false },
      "type": "object",
      "properties": {
        "snapchat_conversion_event": {
          "type": "object",
          "properties": {
            "snapchat_pixel_id": { "type": "string" },
            "event_id":          { "type": "string" },
            "event_name":        { "type": "string" },
            "action_source":     { "type": "string" },
            "event_time":        { "type": "timestamptz" },
            "custom_data": {
              "type": "object",
              "properties": {
                "value":    { "type": "double" },
                "currency": { "type": "string" },
                "order_id": { "type": "string" }
              }
            }
          }
        },
        "sha256_hashed_email": {
          "type": "object",
          "properties": { "value": { "type": "string" } }
        }
      }
    }
  }'

Column names are case sensitive, so keep them lowercase as shown. Activation locks the schema, so add every field you plan to send before you activate. Record the id in the response, then activate the dataset:

curl -X POST https://api.narrative.io/datasets/{dataset_id}/activate \
  -H "Authorization: Bearer $NIO_API_TOKEN"

Required columns

The snapchat_conversion_event column is an object. These properties are required in every event:

Property	Type	Meaning
`snapchat_pixel_id`	`string`	The Snap Pixel that receives the event
`event_id`	`string`	Your unique ID for the event
`event_name`	`string`	A Snapchat event name, such as `PURCHASE`
`action_source`	`string`	Where the conversion happened. Offline events use `OFFLINE`
`event_time`	`timestamptz`, `long`, or `string`	When the event happened

The optional properties are event_tag (string), data_processing_options (an array of strings), and custom_data. A PURCHASE event also needs custom_data.value and custom_data.currency, or the connector drops it. Every field in custom_data is optional:

Field	Type
`value`	`double`
`currency`, `order_id`, `transaction_id`, `content_name`, `content_category`, `content_type`, `search_string`	`string`
`num_items`	`long`
`content_ids`, `brands`	An array of strings
`contents`	An array of objects, each with `id` (`string`, required), `quantity` (`long`), and `item_price` (`double`)
`custom_fields`	A `string` holding a JSON object of scalar values

The dataset also needs at least one of these identifier columns:

Column	Shape of each value
`hashed_email`	`{"value": ..., "type": "..."}`
`raw_email`	A string
`sha256_hashed_email`	`{"value": ...}`
`e164_phone_number`	A string
`telephone_number`	A string
`sha256_hashed_phone_number`	`{"value": ...}`
`maid`	A string
`mobile_id_unique_identifier`	`{"value": ..., "type": "..."}`
`apple_idfa`	`{"value": ...}`
`android_advertising_id`	`{"value": ...}`
`narrative_id`	`{"context": "...", "value": ...}`

Each identifier column is named after its Rosetta Stone attribute, and the connector matches on that column name. A column holds either a plain string or an object. In the dataset schema, declare a string column with "type": "string", and declare an object column with "type": "object" and its properties:

{
  "type": "object",
  "properties": {
    "<string_attribute>": { "type": "string" },
    "<object_attribute>": {
      "type": "object",
      "properties": { "<property>": { "type": "<type>" } }
    }
  }
}

Send an object column as an object in each row:

{"<string_attribute>": "...", "<object_attribute>": {"<property>": "..."}}

See your connector’s reference page for the attributes it accepts and their exact shapes. A purchase row with the required properties and one identifier looks like this:

{"snapchat_conversion_event": {"snapchat_pixel_id": "<PIXEL_ID>", "event_id": "order-1001", "event_name": "PURCHASE", "action_source": "OFFLINE", "event_time": "2026-10-03T14:32:24Z", "custom_data": {"value": 19.99, "currency": "USD"}}, "sha256_hashed_email": {"value": "<SHA-256 of the trimmed, lowercased email>"}}

2. Confirm Snapchat accepts the dataset

Before you create a connection, ask Narrative which connector interfaces the dataset satisfies:

curl -s https://api.narrative.io/datasets/{dataset_id}/interfaces \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → {"dataset_id": 12345,
#    "accepted": [{"app_id": <APP_ID>, "interface_id": "<INTERFACE_ID>"}, ...],
#    "errors": [{"app_id": <APP_ID>, "interface_id": "<INTERFACE_ID>", "details": {...}}, ...]}

The response checks the dataset’s schema against every interface of the connectors your company has installed, and sorts the results into two lists:

accepted lists each interface you can connect the dataset to, by the connector’s app_id and the interface_id.
errors lists each interface the schema does not satisfy. Its details hold the reason, such as "required property '<column>' not found".

Add ?tags=<tag> to check only the interfaces that carry that tag. When the interface you want is under errors, the dataset’s schema doesn’t meet what the interface needs, for example a missing column or property. Activation locks the schema, so create a new dataset that fixes what the error names. For Snapchat, look for the Snapchat Connector ("app_id": 22) with the conversion_events interface in accepted.

{"app_id": 22, "interface_id": "conversion_events"}

3. Create the connection in test mode

Start with test_mode_enabled set to true. In test mode, Snapchat checks each event and records nothing, so test events stay out of your reporting.

curl -X POST https://api.narrative.io/v2/connections \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connections_dataset",
    "dataset_id": 12347,
    "profile_id": "<PROFILE_ID>",
    "quick_settings": {
      "type": "conversion_events",
      "test_mode_enabled": true,
      "historical_data_enabled": true
    }
  }'
# → 201 {"type": "connections_dataset", "id": "<CONNECTION_ID>",
#        "app": {"id": 22, "name": "Snapchat Connector"}, "dataset_id": 12347,
#        "quick_settings": {"type": "conversion_events", "test_mode_enabled": true,
#                           "historical_data_enabled": true},
#        "profile_id": "<PROFILE_ID>", "status": "active", ...}

The connection names no pixel. Each event names its own in snapchat_pixel_id, so one connection can send to every pixel your organization owns. What the connection does describes test_mode_enabled, historical_data_enabled, and their defaults.

4. Upload events

Each line of the file is one event, in a row that matches the schema you declared in step 1. For the columns Snapchat accepts and their shapes, see the Snapchat Connector reference and Required columns. You can load a file into a dataset over the API in two ways:

Signed-URL upload. Your integration uploads one file of up to 3 GB, then asks Narrative to ingest it.
Managed S3 bucket. You write files to an S3 bucket that Narrative manages, and Narrative ingests each batch on its own. Use a managed bucket for files larger than 3 GB, or for files that another system delivers on a schedule.

Choose a file format

The dataset’s file_config.type sets the format of every file you load into it. Parquet and JSON Lines both hold object columns, which nest properties inside one column:

Parquet (parquet) is the most compatible format for connector datasets. It stores nested struct columns and their types natively, and Narrative matches columns to the schema by name at every level.
JSON Lines (json) holds one JSON object per line. Narrative matches each nested object to the schema by name.

CSV datasets (flat) hold only scalar columns, so they can’t carry object columns.

Upload a file with a signed URL

Request an upload URL, then send the file straight to storage:

curl -X POST https://api.narrative.io/uploads/my-file.jsonl \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → {"path": "<UPLOAD_PATH>", "url": "https://...", "expiry": "..."}

curl -X PUT "<url from the response>" --upload-file ./my-file.jsonl

The upload URL is valid for 30 minutes and carries its own signature, so send no authorization header with the PUT.

Keep the path from the response. Narrative assigns its own storage path, which does not match the name you requested, and the ingest request needs Narrative’s path rather than yours.

Then ingest the file into the dataset, passing that path as source_file:

curl -X POST https://api.narrative.io/datasets/{dataset_id}/upload \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"source_file": "<UPLOAD_PATH>"}'

Ingestion runs in the background. Watch the record count on the dataset to know when it has finished:

curl -s https://api.narrative.io/datasets/{dataset_id} \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → .stats.active_dataset_stored_records

The count moves from zero to your row count, typically within a couple of minutes. Each ingested file adds a new snapshot to the dataset, and every active connection on the dataset delivers that snapshot.

Write files to a managed S3 bucket

A managed bucket is an S3 bucket that Narrative creates for your company. You write each batch of files into its own folder under the dataset’s path in the bucket, then write an empty _NIO_COMMIT file into that batch folder. Narrative ingests every file in the batch folder when the commit file appears, so you make no upload or ingest request. A file can be as large as S3 accepts. See Ingesting Files from a Managed S3 Bucket to create the bucket, grant your AWS account access, and lay out the folders.

5. Check the results

Subscribe to delivery notifications to hear about each delivery. The connector sends conversion.delivery.completed when a delivery of conversion events finishes, and conversion.delivery.failed when one fails. To read the connection back:

curl -s https://api.narrative.io/v2/connections/{connection_id} \
  -H "Authorization: Bearer $NIO_API_TOKEN"

Going live

When the test deliveries look right, send real conversions:

Create a connection on the dataset using the same request as step 3, but set test_mode_enabled to false:

curl -X POST https://api.narrative.io/v2/connections \
  -H "Authorization: Bearer $NIO_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "connections_dataset",
    "dataset_id": 12347,
    "profile_id": "<PROFILE_ID>",
    "quick_settings": {
      "type": "conversion_events",
      "test_mode_enabled": false,
      "historical_data_enabled": true
    }
  }'

Delete the test connection with DELETE /v2/connections/{connection_id}.

Events sent through the new connection count as real conversions.

Keeping events flowing

Write new events to the dataset. The connection keeps running, so new rows reach Snapchat without further calls.

Stopping delivery

curl -X DELETE https://api.narrative.io/v2/connections/{connection_id} \
  -H "Authorization: Bearer $NIO_API_TOKEN"
# → 200 {}

Deleting the connection archives it and stops further events from reaching Snapchat. Events already sent stay in Snapchat.

Troubleshooting

Symptom	Cause	Fix
`400 Dataset Schema Incompatible with Connector` with `required property 'snapchat_conversion_event' not found`	The dataset has no `snapchat_conversion_event` column	Create a new dataset with the schema in step 1

Getting help

Contact your Narrative relationship manager with your company ID, the dataset ID, and the failing request and response.

Delivering customer lists via the API

Deliver hashed identifiers into a Snapchat customer list

Snapchat Connector

Supported identifiers and profile setup

Connector Interfaces

Why a dataset connects to an interface rather than a connector

API Keys

Create and rotate keys for programmatic access

Overview

Platform

Data Ingestion

Data Planes

Querying with NQL

Data Collaboration

Identity Resolution

Data Activation

Audience Studio

Connectors

Connector APIs

Compliance

Rosetta Stone

Account Settings

Workflows

Webhooks

Data Collaboration MCP Server

Tools

SDKs

Sending Conversion Events to Snapchat via the API

1. Create the dataset

Required columns

2. Confirm Snapchat accepts the dataset

3. Create the connection in test mode

4. Upload events

Choose a file format

Upload a file with a signed URL

Write files to a managed S3 bucket

5. Check the results

Going live

Keeping events flowing

Stopping delivery

Troubleshooting

Getting help

Delivering customer lists via the API

Snapchat Connector

Connector Interfaces

API Keys

​1. Create the dataset

​Required columns

​2. Confirm Snapchat accepts the dataset

​3. Create the connection in test mode

​4. Upload events

​Choose a file format

​Upload a file with a signed URL

​Write files to a managed S3 bucket

​5. Check the results

​Going live

​Keeping events flowing

​Stopping delivery

​Troubleshooting

​Getting help

​Related content

Delivering customer lists via the API

Snapchat Connector

Connector Interfaces

API Keys

1. Create the dataset

Required columns

2. Confirm Snapchat accepts the dataset

3. Create the connection in test mode

4. Upload events

Choose a file format

Upload a file with a signed URL

Write files to a managed S3 bucket

5. Check the results

Going live

Keeping events flowing

Stopping delivery

Troubleshooting

Getting help

Related content