Webhooks
These are the steps to setting up your integration with to.co using Webhooks:
Webhooks can be used to send data about to.co events to your server or any other application that can handle HTTP POST calls. to.co lets you set up webhooks to be triggered by different events for example, Org updates or Messages captured by to.co Forms.
Create a Webhook Integration
- From the Webhooks page, you can select New Webhook to add a new webhook. If you have set up integrations with other apps, such as Xero, some system webhooks will be created automatically. These can be viewed by changing the filter to show App Webhooks.
- Enter your webhook options into the form.
Webhook Events
The following events can be selected to trigger the Webhook:
| Event Type | Trigger | Payload Model |
|---|---|---|
| Contact Added | When you add a private Contact to your account | Contact |
| Contact Deleted | When you delete a private Contact from your account | Contact |
| Contact Updated | When you update a private Contact on your account | Contact Updated |
| Document Approved | When a Document is approved | Document |
| Form Submission* | When a Form is submitted | Form |
| Message Received | When a Message is received for one of your own Orgs | Message |
| Location Added | When a Location is added to an Org you own, watch or are connected to | Location |
| Location Deleted | When a Location is deleted from an Org you own, watch or are connected to | Location |
| Location Updated | When a Location is updated on an Org you own, watch or are connected to | Location Updated |
| Org Connected | When an Org connection is made with one of your own Orgs | Org |
| Org Disconnected | When an Org disconnects from one of your own Orgs | Org |
| Org Unwatched | When you start watching an Org | Org |
| Org Added | When a private Org you own is created | Org |
| Org Deleted | When a private Org you own is deleted | Org |
| Org Updated | When an Org you own, watch or are connected to is updated | Org Updated |
| Org Watched | When you stop watching an Org | Org |
* See the Submit Settings on the Submit button in the Form Editor.
Form Submission Webhook Payloads
This event can be selected to trigger a Webhook upon Form submission.
Webhook Payloads
When a Webhook is triggered a payload is generated in JSON format (Content-Type of "application/json").