List webhook subscriptions

GET
/hooks/subscriptions

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

curl -X GET "https://terac.com/api/external/v2/hooks/subscriptions"
{
  "data": [
    {
      "id": "string",
      "target_url": "string",
      "event_types": [
        "submission.status.change"
      ],
      "is_enabled": true,
      "confirmed_at": "string",
      "disabled_at": "string",
      "disabled_reason": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

List subscribable webhook event types GET

Read this rather than hardcoding a list: new event types are added without a breaking change, and appear here first.

Create a webhook subscription POST

Returns the signing secret alongside the subscription. Created unconfirmed, so it receives nothing until you call the confirm endpoint and Terac's ping to target_url returns 2xx.