List workspace webhooks

Minimum role: ADMIN. Active workspace via the X-Workspace-Id header.

GET/webhooks

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Query parameters

limitinteger

1-100, default 20

default: 20

cursorstring

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses

200

dataWebhook[]required

Show properties

Array of Webhook

idstringrequired

urlstringrequired

eventsstring[]required

activebooleanrequired

lastDeliveryAtstring | nullrequired

Show properties

Any of:

string

string

null

null

lastDeliveryStatusinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

failureCountintegerrequired

min -9007199254740991 · max 9007199254740991

createdAtstringrequired

updatedAtstringrequired

pagePagerequired

Show properties

nextCursorstring | nullrequired

Show properties

Any of:

string

string

null

null

hasMorebooleanrequired

totalinteger

min -9007199254740991 · max 9007199254740991

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

limitquery1-100, default 20cursorqueryX-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/webhooks' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/webhooks", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/webhooks",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": [
    {
      "id": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "active": true,
      "lastDeliveryAt": "string",
      "lastDeliveryStatus": -9007199254740991,
      "failureCount": -9007199254740991,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "page": {
    "nextCursor": "string",
    "hasMore": true,
    "total": -9007199254740991
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}