Send a webhook automatically
A send-webhook action pushes selected submission data from ApplySG to an external system when a trigger fires. Use it to keep another system in step with ApplySG, for example to start a disbursement in a finance system.
Who this applies to
- Audience: Configurators and integrators.
- Access required: The Manage Automations and Manage Target Systems permissions on the scheme.
- Assumed knowledge: The receiving system is ready to accept the data.
Prerequisites
- Allow ApplySG’s IP addresses on your firewall, if your system restricts incoming traffic. The addresses are in the next section.
- A target system for the receiving endpoint. Refer to Set up a target system.
ApplySG IP addresses
ApplySG sends webhook data from these addresses.
| Environment | IP addresses |
|---|---|
| Staging | 18.142.73.204, 18.139.195.196 |
| Production | 18.140.105.96, 54.255.111.216 |
Steps
- Create an automation with the Submission is created, Submission is updated or Submission is transited trigger. Refer to Create an automation.
- In the automation editor, select Send webhook as the action.
- Select the target system or systems to send the payload to.
- Select the data fields to include in the payload.
- Select Add Action.
- Set the automation to Active.
When the trigger fires, ApplySG sends the payload to each target system that you selected.
Constraints and limitations
| Constraint | Detail |
|---|---|
| Target systems | Up to 5 target systems for each webhook action. |
| Triggers | Supported for the created, updated and transited triggers. |
| Permissions | You need Manage Automations and Manage Target Systems. |
| Endpoint rules | The target system must meet the rules for HTTPS, certificates and allowed hosts. Refer to Set up a target system. |
Related features
- Set up a target system: configure the receiving endpoint.
- Models of adoption: how webhooks connect ApplySG to your systems.
