List subscribable webhook event types

GET
/hooks/event-types

Lists the event types a webhook subscription can receive, each with a description. Read this rather than hardcoding a list: new event types are added without a breaking change, and appear here first.

Authorization

apiKey
Authorization<token>

API key as Bearer token: Authorization: Bearer

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://terac.com/api/external/v2/hooks/event-types"
{
  "data": [
    {
      "event_type": "submission.status.change",
      "description": "string"
    }
  ]
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required. Include Authorization: Bearer <key> header."
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "This account is not permitted to use the API."
  }
}

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded. Retry after 61 seconds."
  }
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

List options for a filter GET

Lists the allowed values for one filter; send an option's `id`, not its `name`, as the value in an opportunity's `filters`. `search` matches ids, names and alternate names, ignoring case and accents. Results are paged by number with `page` and `per_page`, and `meta.total` counts every match. State options need `country_id`, and city options need `country_id` with an optional `state_id`; without `country_id` both lists are empty. An unknown `filter_slug` returns 400.

List webhook subscriptions GET

Lists every webhook subscription in your organization, one per target URL, with its event types and whether it is confirmed and enabled. Not paginated. Signing secrets are left out; read one from `GET /hooks/subscriptions/{subscriptionId}/secret`.