Custom Recipients

Leandro
Leandro
  • Updated

Feature Snapshot

Summary:
Custom recipient integrations are account‑specific delivery configurations that allow you to design, control, and fully customize how your lead data is sent from LeadConduit to external systems using a custom approach.

Key Benefits:

  • Complete customization of endpoint URLs, authentication methods, and field mappings so the integration matches your client’s unique requirements.
  • Strict account control that ensures only you can access and modify the custom recipient settings, preserving data integrity and security.
  • Flexibility to incorporate specialized parameters and dynamic processing using custom logic and mapping techniques not available in standard, built‑in integrations.

Typical Use Cases:

  • When sending leads to a niche CRM, marketing platform, or external system that isn’t supported by pre‑built integrations.
  • When specific security, compliance, or business rules require a tailored data delivery configuration.
  • When you need to use custom field mappings, hardcoded values, and advanced authentication (such as token‑authenticated JSON or custom XML) to meet recipient requirements.

How the Custom Recipient Integrations work?

Custom recipient integrations are designed and managed solely within your account. Unlike built‑in integrations that come pre‑configured and available globally, custom recipients let you build a custom integration where you define every parameter—from the target URL and authentication method (such as Bearer token or HTTP Basic) to the exact field mappings using dot notation. This enables you to handle complex data formatting (including nested JSON or custom XML structures), apply dynamic logic based on recipient outcomes, and ensure that only validated, high‑quality leads reach your destination systems. In short, custom recipients let you control the entire data delivery journey with precision.

Step‑by‑Step Instructions

  1. Create a New Custom Recipient:
    In your LeadConduit flow editor, navigate to the “Add to Flow” menu and click on “Integration”. Click the “Create Custom Recipient” button. Fill in the required details such as a unique recipient name and clear description that explains its purpose and target system.

  2. Configure Integration Settings:
    Choose the integration type (for example, JSON or XML) and enter the target endpoint URL along with required authentication parameters (e.g., API tokens, HTTP Basic credentials, or Bearer tokens).

  3. Set Up Field and Data Mappings:
    Using the field mapping interface, map your LeadConduit flow fields and any hardcoded or transformed values to the recipient’s expected parameters. Use dot‑notation if necessary (for nested JSON or custom XML) and ensure matching data formats.

  4. Save and Test Your Integration:
    Click “Save” to apply your settings. Then run a test lead through your flow. Check the LeadConduit Events tab to see that the delivery step logs a successful transmission and that the custom recipient’s name appears with the proper outcome.

Map Fields modal for Custom Recipient


Validation & Monitoring (optional)

  • Test the Setup: Submit a sample test lead through your flow to verify that the authentication, field mappings, and delivery endpoint are configured correctly, and that the recipient responds as expected (e.g., returns a “success” status).
  • Where to Monitor?: Check the LeadConduit Events tab to monitor recipient responses and review detailed logs; additionally, set up dashboard alerts or email notifications for recipient errors.

Best Practices

  • Use clear and descriptive names along with detailed descriptions for every custom recipient so that its purpose is immediately obvious to all team members.
  • Thoroughly test your custom recipient integration with a variety of lead data samples to ensure that authentication, dynamic field mappings, and any custom logic function correctly under different conditions.
  • Document all custom configuration details—including endpoint URLs, authentication methods, field mapping paths (using dot notation for nested structures), and any hardcoded values—to simplify troubleshooting and future updates.

Troubleshooting

Symptom / Error Likely Cause Resolution
Custom recipient not delivering data Incorrect endpoint URL, authentication details, or mismatched field mappings Verify and correct the recipient’s endpoint URL, re-check API credentials/token, and review mappings for accuracy.
Field mapping errors (missing or mis‑formatted fields) Incomplete or incorrect field mapping configuration (e.g., wrong dot‑notation) Review and update your outbound field mappings ensuring all nested paths and data formats match recipient expectations.
Recipient returning error responses (e.g., “error”, 401) Token expiration, authentication failure, or recipient system rejecting the data Check the response details in the Events tab, update the authentication token if expired, or adjust data format as per recipient documentation.

Frequently Asked Questions (FAQ)

What exactly is a custom recipient?

A custom recipient is an account‑specific integration that you create within your LeadConduit account. It lets you fully customize how lead data is delivered—including setting endpoint URLs, configuring authentication (such as Bearer tokens), and mapping LeadConduit fields to the recipient’s parameters—ensuring that even non‑standard systems can seamlessly receive your leads.

How do custom recipients differ from built‑in integrations?

Built‑in integrations are pre‑configured and globally available with standard mappings and supported settings. Custom recipients, on the other hand, are designed and managed within your account, allowing complete control over all integration aspects—from custom field mappings and data transformations to advanced authentication methods—which makes them ideal for unique or complex delivery requirements.

Can I update a custom recipient after creating it?

Yes, custom recipients remain fully editable. You can update field mappings, change endpoint URLs, modify authentication credentials, and adjust any other settings as needed without impacting the integrity of previously delivered leads.

Which scenarios benefit most from custom recipient integrations?

Custom recipients are best used when sending leads to systems that are not supported by standard integrations, when unique security or business requirements need tailoring of the data delivery process, or when advanced mapping (using techniques such as dot‑notation for nested JSON or XML) is necessary to match the recipient’s API specifications.


Glossary

Term Definition
Custom Recipient An integration created within your account that enables fully customized delivery configurations tailored to your needs.
Field Mapping The process of assigning LeadConduit flow fields or hardcoded values to the recipient’s expected parameter names, including the use of dot‑notation to navigate nested data structures.
Authentication The method by which the recipient system verifies that the request is coming from an authorized source, often via tokens or API keys.
Dot Notation A syntax used to define the path to a nested value in JSON or XML (for example, lead.FirstName or address.State).

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.