List webhooks
get
https://api.flactrum.com/v1/webhooks
| Required scope | webhooks.read |
| Panel screen | System → Webhooks |
| Success status | 200 |
| Returns | A paginated list of Webhook objects |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| scope | query | string | — |
| branch_id | query | string | — |
| event | query | string | — |
| min_failures | query | integer | Endpoints failing repeatedly. |
| page | query | integer | Page number. |
| per_page | query | integer | Page size. Values above the maximum are rejected rather than silently clamped. |
| active | query | boolean | Filter by active flag. Omit to get both. |
| sort | query | string | Column to sort by. Each endpoint lists what it accepts. |
| direction | query | string | Sort direction. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | — |
| name | string | — |
| url | string | — |
| scope | string | — |
| branch_id | string|null | — |
| region | string|null | — |
| is_active | boolean | — |
| events | array | — |
| failure_count | integer | Consecutive failures. Editing the endpoint resets it. |
| last_delivered_at | string|null | — |
| last_error | string|null | — |
| secret | string | Only present in the create and rotate responses. Stored encrypted; never returned again. |
Examples
No recorded example yet.