Webhooks LIST

GET 
/webhooks

Required Permissions: Webhook List or Webhook Admin

Request

Query Parameters

sort string

The object key to sort the results by.

sort_asc boolean
page integer
items integer

Responses

200

A JSON Object containing an array of all webhooks.

application/json

Schema

Schema

items integer
page integer

Possible values: >= 1

total integer
webhooks object[]
Array [
id integer
name string
description string
url url
enabled boolean
ordered boolean
max_retries integer
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
events object[]
Array [
webhook_id integer
webhook_event_id integer
enabled boolean
event object
id integer
name string
description string
]
]

Example (from schema)

{
  "items": 0,
  "page": 0,
  "total": 0,
  "webhooks": [
    {
      "id": 0,
      "name": "Slack",
      "description": "Our connection between experiments and Slack",
      "url": "string",
      "enabled": true,
      "ordered": false,
      "max_retries": 10,
      "created_at": "2024-12-12T13:15:10.509Z",
      "created_by_user_id": 0,
      "updated_at": "2024-12-12T13:15:10.509Z",
      "updated_by_user_id": 0,
      "created_by": {
        "archived": false,
        "avatar": {},
        "avatar_file_upload_url": "/cropUrl/100x100/1.png",
        "created_at": "2024-12-12T13:15:10.509Z",
        "created_by_user_id": 0,
        "department": "Marketing",
        "email": "[email protected]"
      },
      "events": [
        {
          "webhook_id": 0,
          "webhook_event_id": 0,
          "enabled": true,
          "event": {
            "id": 0,
            "name": "ExperimentCreated",
            "description": "Event generated when an experiment draft is created."
          }
        }
      ]
    }
  ]
}

Loading...