Webhooks: List

Description

Retrieve a list of case webhooks. Returns every webhook you can access, or only those for a specific team when team_id is supplied.

See the Get Cases API to learn more about cases.

Request

HTTP Method: GET

Query Parameter	Description
team_id	Optional Restrict the results to a single team.
per_page	Optional Set the number of results returned per page. Defaults to 20, maximum is 50.
page	Optional Specify the page of results to return if there are multiple pages. Defaults to page 1.

curl -X GET \
  'https://<tenant-domain>/api/v1/case_webhooks?team_id=<<team_id>>' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object containing an array of case webhooks.

Field description

Parameter	Description
webhooks	An array of webhook objects.
meta	Object containing pagination information.

Webhook object fields

Parameter	Description
id	The webhook ID.
name	The webhook name, or null if it has none.
url	The destination URL the webhook posts to.
version_number	The payload version (1.0 or 2.0).
notifications	An array of event types that trigger the webhook (or ["ALL"] for all).
team	The team the webhook belongs to.

Team object fields

Parameter	Description
id	The team ID.
name	The team name.

Sample response

{
  "webhooks": [
    {
      "id": 1,
      "name": "Case notifier",
      "url": "https://example.com/webhook",
      "version_number": 2.0,
      "notifications": ["ALL"],
      "team": {
        "id": 10,
        "name": "Security"
      }
    },
    {
      "id": 2,
      "name": null,
      "url": "https://hooks.slack.com/services/T0/B0/XXXX",
      "version_number": 2.0,
      "notifications": ["COMMENTED", "STATUS_UPDATED"],
      "team": {
        "id": 10,
        "name": "Security"
      }
    }
  ],
  "meta": {
    "current_page": "https://<tenant-domain>/api/v1/case_webhooks?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 2
  }
}