TRtruv
Webhooks

List all webhook endpoints

Changed on

The endpoint returns a list of webhooks.

get/v1/webhooks/

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/webhooks/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Query parameters

enabledboolean

Filter by active (true) or disabled (false) webhooks.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "webhook_url": "http://example.com/",
      "events": [
        "task-status-updated",
        "order-status-updated"
      ],
      "env_type": "dev",
      "created_at": "2022-05-04T11:30:00Z",
      "updated_at": "2022-05-04T12:00:00Z"
    }
  ]
}

Changes

  • 16345eb80970Revision changes
    • warning

      added the new order-batch-completed enum value to the /// response property for the response status

  • e58688835e25Revision changes
    • warning

      added the new certification-completed enum value to the /// response property for the response status

    • warning

      added the new order-finalized enum value to the /// response property for the response status

    • info

      added the non-success response with the status