Customizable integration with own system (Webhook)

Integration type

Output: this integration type sends lead data from RD Station to a destination tool, specified in the setting.

What does this integration do?

This setting allows you to send lead data from RD Station to other tools that have a data input URL. This URL needs to be able to read and consume data sent in JSON format.

Observations and requirements

• Have the URL of the other system, which will receive data in JSON format;
• In the case of custom URLs, it is important to have a developer or be in contact with the support of your other system to check compatibility with the reading of the data packet that RD Station sends.

Step-by-step guide to carry out the integration

1. In RD Station, click the name of your account (top right corner) and select Integrations;
2. In Webhooks, click Configure. On the next screen, click Create Webhook. You will see a new screen with some fields ready to be filled in:
   1. Name: define a name for your integration. Ideally, you should create a name that identifies which tool this information is being sent to. Example: Sending to CRM X;
   2. URL: paste the URL of the tool that will receive the data from RD Station Marketing containing the lead information;
   3. Trigger: choose the trigger that will trigger the sending of the notification:
      • Conversion: Sends the leads that have performed a conversion in RD Station Marketing. You can select only specific conversions or leave it blank. In the case of leaving the field blank, every lead that performs a conversion will be sent;
      • Opportunity: sends the leads marked as Opportunity (star). Example: send the RD Station Marketing lead to the tool only when they are marked as an opportunity, either manually or by a workflow automation.
3. By clicking the button Save Webhook, you will be redirected to the Webhooks configured. Here, you can check to see if the integration with the Webhook worked. To do this, click Verify;
4. If the integration is working correctly, you will receive a positive response. Caso contrário, você vai receber uma mensagem de erro com indicação do que fazer em seguida.

Important

The negative response below is the most common, which indicates that the destination URL does not represent an available server (is incorrect), or that the destination server does not use a security certificate, which is necessary in order to be validated by our webhook. In both cases, it is best to check these issues with your developer or tool support team that provided you with the URL. 

Example of data sent by RD Station

The data will be sent according to the structure below, which is that of a standard JSON:

{
 "leads": [
 {
 "id": "390319847",
 "email": "test@webhook.com",
 "name": "Example RD Station",
 "company": null,
 "job_title": "Analyst",
 "bio": null,
 "public_url": "http:\/\/rdstation.com.br\/leads\/public\/807029c7-267f-4225-8428-87ae2dab34c3",
 "created_at": "2018-09-26T17:57:10.189-03:00",
 "opportunity": "true",
 "number_conversions": "1",
 ...
 }] 
}

You can see a full example of a JSON that we send here. Your developer may also notice examples of direct test data packets of leads from your account. To do this, they can use a temporary data receival URL service, for example: Beeceptor.

These services can generate temporary URLs, which you can use on your webhook, in the place of the desired final URL, in order to send the test, and then observe the result on the website of the URL generator service.

Additional Information

The submitted JSON pattern is unique and immutable. It will always send all available information (which can be checked in the full version), including all custom fields that have been populated.

To test it, it is best to use a lead that has all fields filled in. Because the fields are always sent in the same pattern, it is important for the tool that will receive them to observe these examples in order to program the best way to read them and save the data. The save data function is the responsibility of the destination tool.