When you add a feeder element to your campaign canvas, you are identifying the contacts to include as members of the campaign. The following are the feeder steps that are available:

• Add from List

• Listener

• Webhook
  
  
  

Add From List

Purpose: This step allows you to add contacts from an existing contact list to your campaign workflow.

Configuration Steps:

1. Click on the "Add from List" step.

   

2. The step will now appear on the canvas. When you select it, a pop-up window will open. If desired, you can rename the step (the default name is "Add from List").

   

3. Select the contact list you want to add to the campaign.

   

4. Choose the Re-evaluation Frequency, which can be set in hours, days, or weeks. This checks for new contacts in the list at your specified interval and automatically add the contacts to the workflow. Click on "Save" to finalize the step.
   

   
   
   

Listener

Purpose: This step allows contacts to be added dynamically from Discover or Contact List to an activated campaign.

Configuration Steps:

1. Click on the "Listener" step in the campaign.

   

2. The step will now appear on the canvas. When you select it, a pop-up window will open. If desired, you can rename the step (the default name is "Listener").

   

3. Contacts can be added directly from Discover>Contacts or Contact List, provided the campaign includes this step (listener). In the contacts section, choose “Add to a campaign” to add leads directly to the campaign.

   

4. Select the desired campaign from the dropdown and enable the checkbox next to "Listener". Click "Save" to confirm and add the step.

   

Web​hook

Purpose: Webhook in Audienz.ai is a way to receive real-time data from external applications or services, when a specific event occurs. The webhook sends data to another application automatically.

Configuration Steps:

1. Select the Webhook step from the list of Feeder Steps and add it to the canvas.
   

2. Double-click the step, then enter a descriptive name for the webhook (optional). The system will automatically generate a unique Webhook URL and API key. Copy both the Webhook URL and API Key, then click 'Save'.
   

How to use an API Key

Warning: The API key is only displayed once. Copy and securely store it, as it cannot be retrieved later.

• An API key is automatically generated and stored securely in an encrypted format.
  

• The API key is required when sending data and must be included in the request header as "x-api-key".

• If needed, click on the "Regenerate API Key". A new API key can be generated, which will replace the existing one.
  
  

Expected Data Format

• The data must be formatted as a JSON array of objects.

• Only predefined fields are accepted—any additional fields will be rejected.
  

• Below is a list of supported fields for reference. 

1. {
       "data": [
           {
               "personalEmail": "test@portqii.com",
               "firstName": "test",
               "lastName": "test",
               "linkedinUrl": "test",
               "companyName": "test",
               "businessEmail": "test@portqii.com",
               "jobTitle": "test",
               "department": "test",
               "seniorityLevel": "test",
               "sicDescription": "test",
               "primaryContactHeadline": "test",
               "personalPhone": "test",
               "personalCity": "test",
               "personalState": "test",
               "zip": "test",
               "personalCountry": "test"
           }
       ]
   }

Sending Data to the Webhook

Submit your data via an HTTP POST request to your webhook URL, including the required headers below

• Content-Type: application/json

• x-api-key: [Your API Key]

Example request using cURL:

curl -X POST "<webhook url>" \
     -H "Content-Type: application/json" \
     -H "x-api-key: <API_KEY>" \
     -d '{
    "data": [
        {
            "personalEmail": "test@portqii.com",
            "firstName": "test",
            "lastName": "test",
            "linkedinUrl": "test",
            "companyName": "test",
            "businessEmail": "test@portqii.com",
            "jobTitle": "test",
            "department": "test",
            "seniorityLevel": "test",
            "sicDescription": "test",
            "primaryContactHeadline": "test",
            "personalPhone": "test",
            "personalCity": "test",
            "personalState": "test",
            "zip": "test",
            "personalCountry": "test"
        }
    ]
}'

Testing Webhooks

To test a webhook without processing data, use the silent validation endpoint:

<webhookUrl>/silent

This will:

• Confirm if the webhook is active.

• Verify the API key.

• Check if the data format is correct.
  

• Secure API Keys: All API keys are encrypted and stored securely.

• Rate Limiting: Requests are rate-limited to prevent excessive requests.

• Payload Limit: Each payload accepts a maximum of 100 entries; excess data will be considered as invalid data.

• API Key Regeneration: New API keys can be generated from the webhook configuration if needed.
  

• Lead Capture: Automatically collect lead data from external sources.

• Workflow Automation: Trigger business processes based on incoming data.

• Data Synchronization: Keep databases and third-party systems up to date in real time.
  

Troubleshooting Guide

1. Invalid API Key (Error: 401 Unauthorized)

• Ensure the correct API key is included in the request.

• If the issue persists, generate a new API key and update the request.

2. Incorrect Data Format (Error: 400 Bad Request)

• Verify that the data follows the predefined JSON schema.

• Use a JSON validator to check for formatting errors.

3. Webhook Not Active (Error: 403 Forbidden)

• The webhook will only process data if the workflow is active.

• Check the workflow status in the platform settings and activate it if necessary.

4. Too Many Requests (Error: 429 Too Many Requests)

• You may be sending too many requests in a short time.

• Reduce request frequency or contact support for an adjustment to rate limits.

5. Webhook Not Found (Error: 404 Not Found)

• Check the webhook URL and API key for typos.

• If the webhook is missing, delete it and create a new one.

6. API Key Not Found (Error: 404 Not Found)

• If the API key is missing, generate a new one from the webhook settings.

By following these steps, you can efficiently add contacts to your campaigns using Feeder Steps. Whether you’re targeting a predefined list or adding contacts dynamically, this guide ensures a smooth and streamlined process.