Bird Trigger Events - Zeotap docs

What this is

Bird Trigger Events is a real-time destination: it sends event data out of Zeotap CDP to Bird, from a Send to Destinations node in a journey. Bird is a customer communication platform that helps businesses engage with their customers through channels such as email, SMS and WhatsApp. Once the destination is attached to a journey, the events in the categories you select under Event Category are forwarded to your Bird workspace — see Event categories for the full list. Bird has a second, separate destination in Zeotap CDP. Bird - Customer Lists pushes audiences built in Zeotap CDP into the customer lists in your Bird instance, for use in Bird campaigns. Both destinations send data in the same direction, from Zeotap CDP to Bird.

Supported identifiers and actions

This destination identifies a contact in Bird by either an email address or a phone number. You choose which one under Additional Settings, and map the matching catalogue attribute to Identifier Value in the mapping screen. The action you choose under Choose your Action determines which destination fields appear under Map the Fields. To send ecommerce events, choose the Ecommerce Event action. The screenshots on this page were taken with the Audiences Event action selected.

Prerequisites

Before you create the destination in Zeotap CDP, obtain three values from Bird:

Value in Bird	Field in Zeotap CDP
`workspaceId`	Workspace ID
`tracking.endpoint`	Tracking Endpoint
`tracking.writeKey`	Tracking Write Key

All three come from your Bird application configuration, in the two steps below.

Get the tracking values from Bird

Configure your application and obtain the configuration URL

Open the application settings

Navigate to the Application settings in the Developer Cloud.

Enable an application

Enable an Application by following the on-screen instructions.

Set the allowed domains

Specify your website domain(s) as the allowed domains if events will be emitted from your website directly.

If your website homepage is https://example.com, use example.com as the allowed domain. If there are any subdomains such as shop.example.com, list them as well.
Multiple domains can be specified with commas separating them.
If events will be emitted from servers, you can leave the allowed domains empty.

Copy the configuration URL

Once enabled, you will see a config page with a snippet similar to this:

YOUR_CONFIG_URL:  https://api.bird.com/workspaces/<your-workspace-id>/applications/<your-application-id>/signature/<signature>

Retrieve the workspace ID, tracking endpoint and write key

Send a GET request to the configuration URL you obtained above.

curl -X GET "YOUR_CONFIG_URL" \
  -H "Content-Type: application/json"

The response carries the three values you need — workspaceId, tracking.endpoint and tracking.writeKey:

{
    "applicationId": "<your-application-id>",
    "workspaceId": "<your-workspace-id>",
    "apiEndpoint": "https://api.bird.com",
    "allowedDomains": [
        "myapplication.com"
    ],
    "allowedAppBundles": [
        ""
    ],
    "tracking": {
        "connectorId": "<your-connector-id>",
        "enabled": true,
        "writeKey": "<your-write-key>",
        "endpoint": "https://capture.eu-west-1.api.bird.com/tracking/track",
        "trackPageViews": true,
        "anonymousTracking": "enqueue",
        "trackLifecycleEvents": true
    },
    "pushNotifications": {
        "enabled": false,
        "connectorId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "https://capture.eu-west-1.api.bird.com/push-notifications"
    },
    "appInbox": {
        "enabled": false,
        "connectorId": "00000000-0000-0000-0000-000000000000",
        "channelId": "00000000-0000-0000-0000-000000000000",
        "endpoint": "https://capture.eu-west-1.api.bird.com/app-inbox"
    }
}

Retrieve the configuration at the beginning of the session and cache the response for the entire tracking session.

Create the Bird Trigger Events destination

Open Destinations

Log into the Zeotap CDP App and go to the Destinations application.

Start a new destination

Click + Create Destination.

Find the connector

Under All Destinations, search for Bird - Trigger Events.

Enter the connection details

Click Bird - Trigger Events. A screen appears displaying details about the destination on the left. On the right-hand side you will find the fields required for the integration to be established. Enter the following:

A name for the destination.
The Workspace ID.
The Tracking Endpoint.
The Tracking Write Key.

Click Next to proceed to mapping.

Choose the action and map the fields

In the new screen that appears, choose the appropriate action and mapping.

Choose the desired action under Choose your Action, then choose the corresponding identifiers under Map the Fields.
From the dropdown at the bottom, select either the email address or the phone number as the identifier and map it accordingly. By default, the output identifiers that are accepted by the platform — such as email IDs and phone numbers — are displayed. You can edit, add or remove an identifier from the list.
Click Save Mapping.

Destinations mapping screen with Choose your Action set to Audiences Event and a list of Event Attributes destination fields waiting to be mapped to catalogue attributes

Set the identifier type

Under the Additional Settings section, choose the Identifier from the dropdown.

You can select either Email or Phone as the identifier.
You need to map the value corresponding to this identifier in the mapping section mentioned above.

Lower half of the mapping screen showing the required Identifier Value row and the Additional Settings section with the Identifier dropdown

Add the destination to a journey

After creating the destination, link it in the Send to Destinations node within the workflow.

Add a Send to Destinations node

In the workflow, click + and choose Send to Destinations.

Journey canvas action menu with Send to Destinations highlighted alongside the condition, delay and split actions

Pick the destination

Choose the destination from the list of available destinations by using the search feature.

Send to Destinations picker with the search box highlighted above a grid of existing destination cards

Check the Destination Details tab

Under the Destination Details tab, the Workspace ID, Tracking Write Key and Tracking Endpoint fields are automatically populated based on the values you entered while creating the destination.Under Event Category, choose the appropriate option for what you are sending — see Event categories for the full list.

Bird - Trigger Events panel on the Destination Details tab, showing the Destination Name, Tracking Write Key, Tracking Endpoint and Workspace ID fields with the Event Category dropdown highlighted below them

Set the action and mapping

Under the Destination Settings tab, choose the action and mapping as per your requirement. For example, to send ecommerce events, select the Ecommerce Event action — see Ecommerce attribute groups.

Save

Click Save Destination.

Event categories

The Event Category dropdown lists the following options, each shown as <Group> - <Event> — for example, Ecommerce - Cart Updated.

Group	Event
Ecommerce	Cart Updated, Cart Viewed, Checkout Abandoned, Checkout Updated, Collection Viewed, Order Canceled, Order Confirmed, Order Fulfilled, Product Viewed
Conference	Incoming Call Answered, Incoming Call Unanswered, Incoming Call Voicemail, Outgoing Call Answered, Outgoing Call Unanswered
Messaging	Message Bounced, Message Delivered, Message Delivery Failed, Message Link Clicked, Message Marked Spam, Message Opened, Message Sent, Message Subscribed, Message Unsubscribed
Subscription	Subscription Canceled, Subscription Created, Subscription Updated
Suppressions	Identifier Suppressed, Identifier Unsuppressed
Survey	Csat
Web	Form Submitted, Form Viewed, Page Viewed, Search Submitted
Audiences	Membership Changed

The dropdown also offers a Custom option.

Ecommerce attribute groups

When you select the Ecommerce Event action, the destination fields are offered in the following groups.

Attribute group	Applies to
Event Attributes	Common for all Ecommerce events
Cart Event Attributes	For Cart Updated and Cart Viewed events.
Checkout Event Attributes	For Checkout Started and Checkout Updated events.
Order Event Attributes	Common Properties for Order Related Events.
Order Cancelled Event Attributes	Specific Properties for Order Cancelled Events
Order Fulfilled Event Attributes	Specific Properties for Order Fulfilled Events
Product Event Props	Properties for Product Events

For Order Canceled and Order Fulfilled events, map both the common Order Event Attributes group and the event-specific group, not the event-specific group on its own.

Verify the destination is attached

After you click Save Destination, the destination is attached to the Send to Destinations node. The node shows a card with the connector name, the destination name and the mapping you configured.

Send to Destinations node with a Bird - Trigger Events destination card attached, showing the destination name and its Audiences Event mapping

Next steps

Bird - Customer Lists — the other Bird destination, which pushes audiences built in Zeotap CDP into customer lists in Bird.
Destinations — how a destination is set up and how the field mapping works across the catalogue.
Real-time integrations — the other real-time destinations Zeotap CDP supports.

​What this is

​Supported identifiers and actions

​Prerequisites

​Get the tracking values from Bird

​Configure your application and obtain the configuration URL

​Retrieve the workspace ID, tracking endpoint and write key

​Create the Bird Trigger Events destination

​Add the destination to a journey

​Event categories

​Ecommerce attribute groups

​Verify the destination is attached

​Next steps

What this is

Supported identifiers and actions

Prerequisites

Get the tracking values from Bird

Configure your application and obtain the configuration URL

Retrieve the workspace ID, tracking endpoint and write key

Create the Bird Trigger Events destination

Add the destination to a journey

Event categories

Ecommerce attribute groups

Verify the destination is attached

Next steps