Event Pipes
Last updated
Last updated
Our Event Pipes are used to collect data from all products on our platform. You can use this feature to keep track of everything that can cause an event at BMS, from campaigns to organization creation, allowing you to organize the provided data as you wish.
All event pipes created will be sent to either an Event Store, or you can use a webhook to send this data directly to your data management tool. We provide templates for every event that we can track so you can pick which you want to collect data.
We have a solution that may help you understand how a webhook works, check this article here.
To create an event store, click on , and an event pipe creation screen will pop up.
Name - Set a name for your Event Store.
Tags - Create tags to better identify each event pipe.
To start configuring your event pipe, pick a template of your choice in our Filters tab according to your needs.
Sample Event Template - In this dropdown menu, you will be provided with all templates related to the events that we can track.
In this example, we will be creating an event pipe for ADS - Delivered. This event tracks every Ad that is currently running in a campaign and is delivering impressions. Once we create this event pipe, all data will be sent to an Event Store or a Webhook.
Once we have the template selected, you can check which data will be collected when creating the corresponding Event Pipe.
Path - Specific tag in which you can identify the event. Ex: id, type, source, data.accountId.
Operator - Rule that will be used on this filter,
Value - Which specific value the tag must contain.
In this case, we will be collecting data from ad-delivered events, so this is how the configuration would look.
We specified the Path using the tag "Type", chose the Operator option to "Contains" and added the Value "Ad-delivered". Note that these fields are case sensitive, so the fulfilled fields must match the template.
In this case, our filter failed due to verification in our Value field. These fields are case-sensitive and must match the corresponding information.
Once you have added your filters, move to the targets tab.
Here you will decide where to send the data: whether it will be sent to one or multiple event stores or a webhook.
You must create an event store before using it as a target for your event pipes.
Learn more about Event Stores.
Name your target.
Select "Send to Event Store".
Select the event store you are willing to use.
It is possible to send your data to a webhook provided by your data management tool, select this option to use the data management tool of preference, and then fill out the details.
Name your target.
Select "Call Webhook".
Insert your data management tool's webhook URL.
Payload - Information that will be sent to your webhook.
Result - Status returned and the latency.
Request - Request used by BMS to send you the information for this test.
Response - Received response from your webhook.
When selecting two or more event pipes, the Bulk Actions will be enabled, allowing you to make actions in bulk.
You will be capable of Archiving and Deleting events in bulk.
We advise users to archive instead of deleting, only delete if you are sure of it, the action cannot be undone.
To collect the data, we must insert a filter, by clicking on .
Once you have fulfilled all fields with the corresponding information based on your event pipe, the test filter must have a check confirming that it is working properly . If it is not working properly due to missing information or a typo, it will be presented with a warning sign .
To configure a target, click on and fill out the details according to the chosen target option:
Click on to save your target.
Once you have configured your webhook URL, use our Test Webhook tab to confirm the usability of your webhook tool. Select one of the sample event templates and click on .
If your webhook test is successful, your icon will be presented as and the tabs for your test will be fulfilled.
After finishing all configuration and tests, click on to save your target.
Once everything is configured, click on and your event pipe will be listed.
To enable an event pipe simply flip the toggle and your event store will be enabled.
To edit your event store, click on and an editing screen will pop up, make the necessary changes and then click on .
To archive your event pipe, click on and it will be sent to the archived list. In order to unarchive your event pipe, switch your view to archived events by flipping the toggle . You will then be presented with the list of archived events. Click on to unarchive an event pipe.
To delete an event, click on and a confirmation will be required.
After clicking on , your event pipe will be deleted.
