Articles in this section

Sending an API Webhook with an Automation

Avatar
Jack Davenport
  • Updated
Follow

If you are using the Folio API You can use Webhook to send real-time data to your server when an automation is run.

For example if you are using the API to get all of your Incidents, whenever a new incident is reported you can have an automation that will send off a webhook to your server - who will then use the API to get the information about that newly created Incident.

Adding a Webhook Endpoint

To get started you will need a webhook endpoint setup, this should be a publicly accessible URL that Folio can send the data to.

In Folio you can use the same webhook on multiple automations, so we have a screen on the admin page that allows you to set up all your endpoints.

To start go to the Admin screen and click Integrations, then select Webhook Endpoints 

mceclip0.png

Then click Create Webhook Endpoint

Then give the New endpoint a name, and then put in the URL of your webhook end point and click create.

Adding an webhook to an automation

Once you have some webhooks setup you can add it onto an automation.

On the automation click on the + and then select webhook from the dropdown

Then select the webhook you want to send to when the conditions are met.

You can then change the webhook it sends to by clicking on the card, and you can remove it from the automation from this screen as well.

What the Automation sends

Once the conditions are met Folio will send a POST request to the selected webhook url that contains the payload below

{
 "data": {
       "id": "{{ID of the folio to be used with the api, eg MDBDb250cmFjdC0zODE2}}",
       "key": "FOL-29",
       "title": "Example Folio",
       "automation_name": "{{Automation Name}}"
     }
}

 

Related articles