Custom program extensions

Unlock the ability to integrate with almost any RESTful API that supports basic authentication or no authentication with custom extensions.

Gareth Burroughes avatar
Written by Gareth Burroughes
Updated over a week ago

Custom extension providers can be used in programs to extend the functionality of the application's automation capability. This allows you to make custom HTTP requests to endpoints of your choosing.

Initial setup

You need to supply our account team with the base URL, authentication methods and the name you wish to give your custom extension provider. They'll notify you when initial set up is complete.

You then need to create a profile for this provider, at which point you're ready to use your custom extension within the program builder.

Custom extensions appear under Extensions in the side panel to the left of the program canvas.

Create a profile

You can create a custom extension profile in the Extension profiles tab in the Access area, which is accessed by selecting Access from the settings menu.

  1. Expand the User menu and go to Settings > Access > Extension profiles.

  2. Select ADD, expand the Provider name drop-down menu and select your new custom provider from the list and then select OK.

Add details/authentication for the new profile.

  1. Enter the name for the profile, and select the authentication type it uses. If it uses basic authentication, you must enter the username and password.

    You can also select the check box to limit the rate that requests are made by the profile, as some providers won't allow too many requests to be sent at once by the same profile.

  2. Once done, select SAVE.

Configure your custom extension

  1. Select the node and the configuration side panel opens.

  2. Expand the Profile drop-down and select the profile you wish to use for this action (or you can select the + icon to add another profile).
    ​Supply any additions to the URL, for example, paths like /contact. These can contain personalisation by selecting the personalisation icon on the far right, allowing for /contact/@EMAIL@, or, alternatively, URL parameters such as /contact.php?email=@EMAIL@.

  3. Set the appropriate method of the HTTP request that will be made, and its content-type.

  4. Select Enter headers to open the Custom http headers side panel, add the relevant headers and select Apply once done.

  5. Select Enter body data to open the Body data side panel and add the relevant information to complete the request. Personalisation may again be used here as required.

  6. Select Apply.

Data requirements

It's always your responsibility to ensure you're supplying good, executable data, or your extension call could fail.

Enter node text

You have the option to enter some node text, which is useful for identifying what action or purpose the custom extension node is serving. The text entered displays within the node on the program canvas.

Once a program is activated and a contact reaches this node in your program, the body data entered is personalised with the contact's information and sent to the endpoint specified. The endpoint should then respond with an appropriate response code.

Test the extension

Once happy with your configuration, you should first test the custom extension to ensure it works as expected.

  1. Select Find contact, choose a contact from your Test list and then select Submit to make a test request. The full response is provided underneath, allowing you to see whether the extension is working or not.

  2. After testing successfully, select Apply.

Did this answer your question?