Este artigo está atualmente disponível em inglês e espanhol. Você pode usar esta documentação enquanto ela não estiver disponível em seu idioma.
In Connectif, it is possible to receive data from external systems to use information that is not registered by default in the platform. Through a custom integration, you can synchronize your contact data based on events generated in other platforms.
In this article, you will learn how to create a custom integration to receive data.
Implementation time: 20 minutes.
Difficulty: Medium
When to use it?: When it is necessary to receive data generated in external systems or applications in Connectif.
STEP 1 - Creating the custom integration
1. Go to "Integrations > Custom" and click on Create new integration.
If you work with an ERP, we recommend following these steps to synchronize the data with your Connectif account.
2. Set the "Name" field to identify the integration.
3. (Optional) Customize the color, include a description, or categorize the integration.
4. Click Save.
5. In the Receive Data tab, click Create new receiving event.
STEP 2 - Configuring the "Receive Data" event
(In this section, the fields where the received data will be stored are configured).
6. Click Add a new field to create a custom field and fill in the necessary fields in the right block.
To learn more about custom fields, click here.
It is important that the email field is of email type and is marked as Mandatory and Primary Key, as it will be used to identify the contact.
7. Repeat the action indicated in the previous step as many times as the data you want to receive.
8. Click Save and, in the confirmation screen, click Return to the event list.
STEP 3 - Obtaining the notification endpoint
(In this section, you will learn how to generate the address to notify the created event type, the endpoint).
The endpoint functions similarly to the concept of a webhook: it is a system that waits for an event to occur and reacts by transferring the data to another application or system, in this case to Connectif, using an HTTP call.
9. In the Receive Data tab, click Edit.
10. Click Copy URL to copy the endpoint address to the clipboard.
STEP 4 - Sending data to Connectif
(In this section, you will learn how to establish communication with the endpoint and send data).
11. Make the call to the endpoint to notify it of the event data. The following screenshot is a JSON call made with Postman, following the example illustrated in the article.
Learn how to notify custom events via JavaScript in this article.
The call must be a POST request to the selected endpoint in JSON format. In the body of the call, it is necessary to specify the IDs of the fields configured in the event.
STEP 5 - Synchronizing data with contact information
(This section explains how to synchronize the data in Connectif through a workflow).
12. Go to “Workflows”, click Create new workflow and select Create blank workflow.
13. Create your workflow structure with the trigger node "Trigger [your integration name]" and the action node "Set field".
14. In the "Receive Data Trigger" node, click (Edit node configuration).
15. Verify that the data collected by the "Receive Data Trigger" node from the event in the external system is correct.
If the data is not correct, you can edit it from the receiving event configuration (STEP 2).
16. Click Save.
17. In the "Set Field" node, click (Edit node configuration).
18. Map the variables to assign the information collected by the custom integration to the corresponding contact fields.
To learn more about how to map variables in the "Set Field" node, click here.
19. Click Update.
20. In the workflow, click Save to save the changes and Start to activate it.
Extra: Creating a Dynamic Plus Segment for the integration
With Connectif, you can create a Dynamic Plus Segment to filter by the activities and fields related to the custom integration.
To learn how to create a Dynamic Plus Segment with the contacts from your integration, check out this article.
Once you create a contact segment from the custom integration, it cannot be deleted. Additionally, if any of its fields are being used as a segmentation condition, they cannot be deleted or edited either.
Success!
Your custom integration is ready to receive data.
Keep Learning!
To take full advantage of your Connectif account, we recommend continuing with the following articles:
- Custom integration to send data, to send data from Connectif to external systems or applications.
- Detect and respond to web links created outside of Connectif, to identify and respond to clicks on any link on your website.
-
Integration with Facebook and Instagram, to manage the audiences of your Facebook Ads account with Connect if.
-
Embedded Forms, to detect and collect existing forms on your website in Connectif.