GET
/
webhooks
Lists all the webhooks
curl --request GET \
  --url https://api.sandbox.goteal.co/webhooks \
  --header 'X-API-KEY: <api-key>'
{
  "pagination": {
    "offset": 75,
    "limit": 25,
    "count": 14,
    "total_count": 89
  },
  "webhooks": [
    {
      "webhook_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
      "name": "user-payroll-submitted",
      "events": [
        "user-payroll-submitted",
        "user-payroll-created"
      ],
      "url": "https://webhooks.company.com",
      "created_at": "2019-05-17T00:00:00.000Z"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
orederd_by
enum<string>
default:created_at

The field of the user to order by

Available options:
name,
url,
created_at
Example:

"name"

​
offset
integer
default:0

The offset to start at

Required range: x >= 1
​
limit
integer
default:20

The number of items to return

Required range: 1 <= x <= 100

Response

200
application/json

OK

The response is of type object.