Custom Integration

Learn how to integrate your NeoDove account with Custom Integrations

The Custom Integration module in NeoDove allows you to generate an endpoint to create leads in a specific campaign.

This documentation explains how to create the endpoint and test it using Postman.

Generating the Endpoint

  1. Access NeoDove Admin Portal

    • Log in to NeoDove Admin Portal.

  2. Navigate to Integrations

    • Click on "Integrations" in the Admin Portal.

  3. Enable Custom Integration

    • If the "Custom Integration" option is not enabled, please contact your Customer Success Manager (CSM) or the Support Team to enable it for you.

  4. Start the Integration

    • Click on "Custom Integration" and proceed to the next step.

  5. Select the Parameter Type

    • Select the Custom Integration Parameter Type.

    • Mostly, we select the Body Params rather than Query Params.

  6. Choose the Campaign

    • Select the campaign where you want to create leads.

  7. Submit

    • Click on "Submit" to generate the endpoint.

  8. Endpoint URL

    • You will be taken to the Active Integrations Page, where you'll find the endpoint URL. Copy the URL against the key called "Endpoint."

Testing the Endpoint Using Postman

  1. Open Postman

    • Log in to Postman.

  2. Create a New Request

    • In the Postman workspace, click on the "+" icon next to the "Overview" tab to create a new request.

  3. Configure the Request

    • Change the method from GET to POST.

    • Paste the endpoint URL generated in NeoDove into the "Enter URL or paste text" box.

  4. Set Request Body

    • In the request options, select "Body."

    • Under the Body options, choose "raw."

  5. Specify Data Format

    • Change the drop-down from "Text" to "JSON" since NeoDove only accepts JSON format.

  6. Enter Data in JSON Format

    • In the text area, enter your data in JSON format. Ensure that your JSON includes keys for "name," "mobile," and "email." Mobile is mandatory for lead creation. Other keys for additional data can have custom names.

    Sample of of JSON format is available in the next step. 

  7. {
  "name": "Test Name",
  "mobile": "1234567890",
  "email": "[email protected]",
  "City": "Jaipur",
  "State": "Rajasthan"
}

  8. Test the Endpoint

    • Click the "SEND" button to test the endpoint.

  9. Verify Response

    • In the "Response" tab at the bottom, you should see "OK" if the test is successful.

  10. Check NeoDove

    • Return to NeoDove and navigate to the campaign to verify if a lead has been created with the details from the JSON data.

Important Notes

  • When copying the endpoint URL from NeoDove, make sure to select "Endpoint" (not "Endpoint(Update only)").

  • The method for hitting the endpoint must be POST.

  • Data should be sent in Raw JSON format.

  • Ensure that the keys for the lead's name, mobile number, and email are named "name," "mobile," and "email." Other keys can have custom names.

This documentation should guide you through the process of generating an endpoint and testing it using Postman for Custom Integration in NeoDove.

If you have any further questions or require assistance, please don't hesitate to reach out to our Product Team. We are here to help you make the most of NeoDove's capabilities.

Last updated

Was this helpful?