Custom API

What is Custom API?

Custom API actions facilitate the connection to an external system outside of Plumber. This is beneficial if your workflow requires interaction with an external system.

Limited support shall be provided for Custom API actions, as they are intended for advanced users.

Getting started

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

If you wish to whitelist traffic from Plumber, please specify the following IP addresses

• 52.76.216.61

• 52.74.55.209

• 18.139.42.66

Support policy

Please note that our team may not respond to queries about this feature as it is not currently a priority area. Whilst 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.

Connecting to a system

1. Click "Connect"

1. Under "choose connection", click "+ Add new connection"

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

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

Make a HTTP request

Field	Description	Required?
Method	Available HTTP methods for requests: GET DELETE PATCH POST PUT	✔️
URL	All URLs with a query string will be properly re-encoded. URLs from Plumber (e.g., https://plumber.gov.sg/webhooks/...) are not permitted.	✔️
Custom Headers	Add custom headers here.
Data	Ensure the JSON data is properly formatted. Each key-value pair should be enclosed in curly braces {} with key names in double quotes and values appropriately quoted or unquoted per JSON standards. Use a comma , to separate pairs and validate against a JSON validator to prevent syntax errors. 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: “ ”

FAQ

Can Plumber connect to systems in the intranet space?

Plumber can access intranet systems if specific conditions are fulfilled. To enable integration, intranet systems must whitelist the Plumber IP addresses provided above. Without this whitelisting, Plumber might not be able to connect to any systems within the intranet space.

What can I include in the 'Data' field?

The 'Data' field requires valid JSON input. Please use correct JSON formatting with key-value pairs inside curly braces { }. For more details on JSON formatting, visit this resource.

💡 Tip: You can use tools like the JSON formatter in VSCode or an online JSON validator to quickly check if your data is valid

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

What is meant by limited support for custom APIs?

You may use this feature, but technical knowledge is essential. Users must manage their own API configurations and troubleshooting. While we will assist with some basic issues, we won't write code or solve complex problems. Most implementation queries should be handled independently. We'll only intervene if the core system breaks; otherwise, rely on your own technical expertise or development team.

Can I use Custom API to send attachments?

The Custom API action allows you to send a JSON body, but it doesn't support file attachments.