Skip to main content
GET
/
webhooks
List all webhooks
curl --request GET \
  --url http://localhost:3001/portal-api/webhooks
[
  {
    "ID": "<string>",
    "Name": "<string>",
    "URL": "<string>",
    "Method": "<string>",
    "Timeout": 123,
    "Headers": [
      {
        "ID": "<string>",
        "Name": "<string>",
        "Value": "<string>"
      }
    ],
    "Events": []
  }
]

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

A list of webhooks.

​
ID
string

Unique identifier for the webhook

​
Name
string

Name of the webhook

​
URL
string

URL to which the webhook will send requests

​
Method
string

HTTP method used by the webhook (e.g., GET, POST)

​
Timeout
integer

Timeout in seconds for the webhook request

​
Headers
object[]

List of custom headers included in the webhook request

​
Events
enum<string>[]

List of event types that trigger the webhook

Available options:
AccessRequestApproved,
AccessRequestRejected,
AccessRequestCreated,
OrganisationRequestCreated,
UserRegistered,
OrganisationRequestApproved,
OrganisationRequestRejected,
PasswordReset,
RegisterInvite,
UserAccountActivated,
UserAccountDeactivated,
ApplicationRegistered,
CredentialRegistered,
OrganisationRegistered