Bird Trigger Events - Zeotap docs

Overview

Bird is a customer communication platform that helps businesses engage with their customers through various channels like email, SMS, and WhatsApp. This integration with Zeotap enables you to send Event data to Bird. Pre requisites

workspaceId
tracking.endpoint
tracking.writeKey

The authentication process contains two steps:

Configuring your Application and obtaining the Configuration URL.a. Navigate to the Application settings in the Developer Cloud.b. Enable an Application by following the on-screen instructions.c. Specify your website domain(s) as the allowed domains if events will be emitted from your website directly. For example:i. If your website homepage is “https://example.com ”, use “example.com” as the allowed domain. If there are any subdomains like “shop.example.com”, list them as well.ii. Multiple domains can be specified with commas separating them.iii. If events will be emitted from servers, you can leave the allowed domains empty.d. Once enabled, you’ll see a config page with a snippet similar to

Code

YOUR_CONFIG_URL:  https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/applications/4640861f-f29b-48b6-8baa-a0f23249cf77/signature/2024-11-26T15-00-00_88eb9214e4

Getting the workspaceId ,tracking.endpoint, tracking.writeKey.After obtaining YOUR_CONFIG_URL, you need to send a GET request to obtain the workspaceId, tracking.endpoint & tracking.writeKeyRequest :

Code

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

Response :

Code

{
    "applicationId": "4640861f-f29b-48b6-8baa-a0f23249cf77",
    "workspaceId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
    "apiEndpoint": "https://api.bird.com",
    "allowedDomains": [
        "myapplication.com"
    ],
    "allowedAppBundles": [
        ""
    ],
    "tracking": {
        "connectorId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
        "enabled": true,
        "writeKey": "a1405560-c8d3-4b1a-877d-3f449ad95352",
        "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"
    }
}

You will need the following information from the response for the subsequent steps:
workspaceId
tracking.endpoint
tracking.writeKey We recommend retrieving the configuration at the beginning of the session and caching the response for the entire tracking session. Once you have this information, you can move on to the next step: Track events.

Creating a Destination

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

Click + Create Destination.

Under All Destinations, search for Bird Trigger Events.

Click Bird Trigger Events Lists. A screen appears displaying details about the particular destination towards the left. On the right-hand side of the screen find a list of fields that are required for the integration to be established. Enter the required details as mentioned in the following steps:a. Enter a name for the Destination.b. Enter the Workspace ID.c. Enter the Tracking Endpoint.d. Enter the Tracking Write Key.e. Click Next to proceed to mapping.

In the new screen that appears, choose the appropriate Action and mapping as explained below.a. Choose the desired action under Choose your Action and then choose the corresponding identifiers under Map the Fields. From the dropdown at the bottom, you must select either the email address or 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. However, you can edit, add, or remove an identifier from the list.b. Click Save Mapping.

Under the Additional Settings section choose the Identifier type from the dropdown.a. You can select either Email or Phone as the Identifier type.b. You need to map the value corresponding to this Identifier type in the mapping section mentioned above.

Activate the Destination on Journeys

After creating a destination, next, you need to link it in the Send to Destination node within the workflow, as explained below.

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

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

Under the Destination Details tab, the Workspace ID, Tracking Write Key and Tracking Endpoint fields are automatically populated based on the value that you have entered while creating the destination.a. Under the Event Category, choose the appropriate option based on your requirement.i. Ecommerce - Cart Updatedii. Ecommerce - Cart Viewediii. Ecommerce - Checkout Abandonediv. Ecommerce - Checkout Updatedv. Ecommerce - Collection Viewedvi. Ecommerce - Order Canceledvii. Ecommerce - Order Confirmedviii. Ecommerce - Order Fulfilledix. Ecommerce - Product Viewedx. Conference - Incoming Call Answeredxi. Conference - Incoming Call Unansweredxii. Conference - Incoming Call Voicemailxiii. Conference - Outgoing Call Answeredxiv. Conference - Outgoing Call Unansweredxv. Messaging - Message Bouncedxvi. Messaging - Message Deliveredxvii. Messaging - Message Delivery Failedxviii. Messaging - Message Link Clickedxix. Messaging - Message Marked Spamxx. Messaging - Message Openedxxi. Messaging - Message Sentxxii. Messaging - Message Subscribedxxiii. Messaging - Message Unsubscribedxxiv. Subscription - Subscription Canceledxxv. Subscription - Subscription Createdxxvi. Subscription - Subscription Updatedxxvii. Suppressions - Identifier Suppressedxxviii. Suppressions - Identifier Unsuppressedxxix. Survey - Csatxxx. Web - Form Submittedxxxi. Web - Form Viewedxxxii. Web - Page Viewedxxxiii. Web - Search Submittedxxxiv. Audiences - Membership Changedxxxv. Custom .

Under the Destination Settings tab, choose the Action and mapping as per your requirement.a. For example to send Ecommerce events, select the Ecommerce Event Action

Event Category	Description
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

Note: For Order Cancelled and Order Fulfilled Events, you need to map bot

Upon clicking Save Destination. The destination is attached as shown in the image below.

​Overview

​Creating a Destination

​Activate the Destination on Journeys

Overview

Creating a Destination

Activate the Destination on Journeys