Program extensions: Custom extensions

Please note: This article assumes you have read 'Using program extensions'.

Summary

Custom extension providers can be used in programs to extend the functionality of the application's automation capability. This will allow you to make custom HTTP requests to endpoints of your choosing, unlocking the ability to integrate with almost any RESTful API that supports basic authentication or no authentication.

Initial setup

You will need to supply our account team with the base URL, authentication methods and the name you wish to give your custom extension provider. They will notify you when this has been done. You will then need to create a profile for it, at which point you'll be ready to utilize your provider within the program builder.

It will appear under 'Extensions' in the main panel to the left of the program canvas.

Creating a profile

You can create a profile in the 'Extension profiles' tab under 'Account settings'.

create_custom_ext_profile.png

Click on Add to produce the provider type dropdown, select your new custom provider from the list and then click OK

select_a_provider.png

Add details/authentication for the new profile and then click Save.

new_profile_details.png

Configuring your custom extension

Once you have dragged and dropped your custom extension into your program, you will need to configure it.

Click on the node and the configuration panel will slide in from the right.

Select the profile you wish to use for this action from the 'Profile' dropdown and supply any additions to the URL, for example paths like '/contact'. These can also optionally contain personalization by clicking on  personlisation_icon.png, allowing for '/contact/@EMAIL@', or, alternatively, URL parameters such as '/contact.php?email=@EMAIL@'. Set the appropriate method of the HTTP request that is to be made, and its content-type.

The body data field should be populated with the relevant information to complete the request. Personalization may again be used here as required.

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

Optionally, you can also enter some node text if you want to identify what action or purpose the custom extension node is serving. The text you enter will display within the node on the program canvas.

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

After testing successfully, click Apply

config_cust_ext.png

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.