List all webhooks belonging to a specific org.

List all webhooks belonging to a specific org.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Webhooks under the Setup & Administration category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /webhooks

List all webhooks belonging to a specific org.

cURL

curl --request GET \
  --url https://api.samsara.com/webhooks \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "id": "23918",
      "name": "Webhook-123",
      "secretKey": "11121-31231-1231212",
      "url": "https://www.webhook-123.com/webhook/listener",
      "version": "2018-01-01",
      "customHeaders": [
        {
          "key": "format",
          "value": "xcmol-532"
        }
      ],
      "eventTypes": [
        "AddressCreated",
        "AddressCreated",
        "AddressCreated",
        "AddressCreated"
      ]
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ids · string

A filter on the data based on this comma-separated list of webhook IDs. Example: ids=49412323223,49412329928

limit · integer · default: 512

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

Required range: 1 <= x <= 512

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Response

200

application/json

OK response.

data · object[] · required

This is a list of Webhooks.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes