Custom API

The implementation might require some changes on the system that is receiving raw data from Plumber, speak to the system owner or pass this guide to the relevant stakeholders to facilitate the process.

Support policy

Please note that our team may not respond to queries about this feature as it is not currently a priority area. While the feature remains available for use, users should consult their technical teams or documentation for implementation support. We are focusing our efforts on other strategic priorities and core system functionality. If you find any information lacking in this document, we are more than happy to update it to better serve your needs

FAQ

Can Plumber connect to systems in the intranet space?

Yes, Plumber can connect to systems in the intranet space, but only if certain conditions are met. The intranet systems must whitelist the Plumber IP addresses listed in the section above. Without this whitelisting, Plumber will not be able to integrate with or access any systems within the intranet space.

Can I use Custom API to send attachments?

No, the Custom API action only supports sending a JSON body and does not support file attachments.

What can I include in the 'Data' field?

The ‘Data’ field only accepts valid JSON data. Ensure your input follows proper JSON formatting, including key-value pairs enclosed in curly braces { }. Find out more about proper JSON formatting here.

What is meant by limited support for custom APIs?

You can use this feature, but technical knowledge is required. Users must handle their own API configurations and troubleshooting. While we'll help with some basic issues, we won't write code or fix complex problems. You'll need to handle most implementation questions yourself. We'll only step in if something breaks the core system - otherwise, rely on your own technical expertise or dev team.

Example:

How to address invalid JSON data errors:

• Ensure that you use "double quotes" instead of 'single quotes'

• Ensure that you are not using curly or fancy quotes: “ ”

• Ensure that there are not trailing commas

How to set up custom api action?

1. Select "Custom API" under "Choose an app"

2. Select "Make a HTTP request" under "Choose an event"

3. Click "Continue".

1. Select "Add new connection"

1. Under "Label", give a name you like for the connection. This is just for your own identification purpose.

2. Under "Headers", enter the identifying parameters for the system you're interacting with.

1. Select the relevant methods (GET, DELETE, PATCH, POST, PUT)

2. Fill in the remaining fields according to how your system is configured

3. Click "Continue" when you're done

1. Upon successful request, you'll be able to view the data provided by the external system