Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://management-api.fpjs.io/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Version: <x-api-version>'
{
  "data": [
    {
      "id": "wh_HYv9YfsIIUjpvR",
      "description": "My Webhook",
      "status": "enabled",
      "verified": false,
      "environment": {},
      "url": "https://website.com/webhook",
      "legacy": true,
      "basic_auth": {},
      "created_at": "2023-11-07T05:31:56Z",
      "signing_key": "<string>",
      "last_enabled_at": {},
      "last_disabled_at": {}
    }
  ],
  "metadata": {
    "pagination": {
      "nextCursor": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI",
      "prevCursor": null
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-API-Version
string
required

Management API version.

Query Parameters

​
status
enum<string>

Filters by webhook status.

Available options:
enabled,
disabled
​
environment
string

Filters by webhook environment ID.

​
cursor
string

Cursor token used for pagination. Response will contain items appearing after the given cursor.

​
limit
number
default:10

Sets the maximum number of items contained in a single page.

Required range: 0 <= x <= 101

Response

List of webhooks matching the given query.

​
data
object[]
required
​
metadata
object
required