Webhooks API

The Webhooks API gives you access to manage your organization's webhooks programmatically.

For more general information about webhooks, or details of responsibilities your webhook endpoint must meet, see the Webhooks Overview.

Properties

PropertyTypeRequiredReadonlyDescription
namestringyesnoThe name of the webhook.
urlstringyesnoThe HTTP URL that will receive event requets as they occur.
activebooleannonoDefault: true. If true, this webhook will receive event requests. If false, this webhook will not receive event requests.
idstringnoyesThe id of the webhook.
created_atstringnoyesTimestamp when the webhook was created.
updated_atstringnoyesTimestamp when the webhook was last updated.

Validations

The following properties must be included in order to create/update a webhook object in our system. Any validation errors will return a 422 and an object with a list of validation errors.

Required Properties

PropertyTypeDescriptionExample
namestringThe name of the choice webhook."Fire Hydrant Inventory Emails"
urlstringThe HTTP URL that will receive event requets as they occur."https://my-webhook-processing-script.php"

Example validation response if url is not included:

{
  "webhook": {
    "errors": {
      "url": ["can't be blank"]
    }
  }
}

Notes

  • Your plan must include the Developer Pack and the member must have a role with permissions to Change Organization Profile to manage webhooks.

Sample Response

{
  "webhook": {
    "name": "Fire Hydrant Inventory Emails",
    "url": "https://script.google.com/macros/s/AKfycbyrR_bJr0XEW30DbDEXT3yjle5akRa9Dci7q6H0VTA_Oov86Vj/exec",
    "active": true,
    "id": "1617ae52-0f8a-463f-bfc0-89787c6474ea",
    "created_at": "2014-08-19T20:24:31Z",
    "updated_at": "2014-12-17T04:28:05Z"
  }
}