Skip to main content
All CollectionsSwaarm Performance MarketingProductLead Generation
Outgoing Leads: Logs, Endpoints and Automation
Outgoing Leads: Logs, Endpoints and Automation

How to configure an advertiser's endpoint to forward leads and track forwarded leads

Updated over a month ago

Outgoing Leads

Outgoing leads are divided into three sections:

Logs Explained

You can see all the leads that are forwarded to the advertiser in the Logs section.

  • You can select the fields that you want to load the logs for, the lightening icon on the Fields means that your selection will be pre-saved every time you revisit the page

  • You can apply multiple filters on the table using the +Add Filter option

  • You can download the table with selected fields in CSV

It will contain the following details about each lead:

ID - Log ID

Time - Timestamp at which the lead is forwarded

Lead ID - ID of the lead that refers to the lead in the Incoming lead table

Success - Whether the lead has been forwarded successfully or not
โ€‹Request URL - Advertiser's request URL configured in the endpoint

Request Body - Request body that's been sent to the advertiser i.e. lead information

Response Status Code - This refers to the status code after the lead has been forwarded, if it's 200 then it's a success

Response Body - The response that we receive from the advertiser's API, will be a success message or failed reasons in case the forwarding failed due to some reason

Forwarding Lead ID

Endpoints Explained

How to create an Endpoint?

You can configure the Advertiser's API endpoint here with the following steps:

  1. Go to OutGoing Leads > Endpoints

  2. Click on +Create Endpoint

  3. A widget will open up, where you have to fill in the following details:

    1. Select the Advertiser in the platform you want to create an endpoint for

    2. You can enter the respective lead publisher tracking link in the URL, this will be your URL to load an API

    3. select the appropriate HTTP Method for the API based on the specific requirements; options include GET, POST, and PUT

    4. Select the content type that specifies the type of data being sent in the request, we support the following content types:

      1. application/x-www-form-URL-encoded: Commonly used for HTML form data submitted in the body of a POST request

      2. application/JSON: Used when sending or receiving JSON (JavaScript Object Notation) data

      3. multipart/form-data: Used for sending binary data, usually in the context of file uploads

    5. Add the "Request Body" structure

  4. Save

After creating an endpoint in the Lead Generation, you will find an entry in the table displaying its details. You have the flexibility to edit or delete it at any time.

Automation Explained

The automation section under outgoing leads helps automate the forwarding of leads to advertiser endpoints based on lead targeting and other defined conditions.

How to create an automation rule?

You can configure an automation rule for forwarding leads by following the steps below:

  1. Go to OutGoing Leads > Automation

  2. Click on +Create Rule

  3. A widget will open up, where you have to fill in the following details:

    1. Add a human-friendly Name to identify the rule

    2. Next select the Mode of the rule. There are 2 types of modes:

      1. Cascading: The cascading mode will go through all the rules where the lead targeting matches that of the automation rule targeting in the order of priority. The highest priority rule is selected and the lead is sent to that endpoint. In case of two rules that match and have the same priority, then the lead is randomly sent to one of the two.

      2. Parallel: The Parallel mode will through all the rules where the lead targeting matches that of the automation rule targeting and the lead will be sent to all the matching endpoints.

    3. Priority: Priority is a number that decides the order in which the cascading rules are selected. 1 being the highest.

    4. Endpoint: Select the advertiser's endpoint to which the respective rule applies

    5. Targeting: Here you can add the list rules that need to match for the lead to be automatically forwarded to this endpoint. Multiple rules or group of rules can added by using AND and OR operators.

    6. Active: You can set the rule as active by clicking on the checkbox.

    7. Save

Did this answer your question?