API reference · Webhooks
GET/api/v1/webhooks
Product availabilityAlgaPSA

List webhooks

Lists tenant webhooks with pagination and filter query fields.

RBAC · webhook

Query parameters

pagestringOptional
limitstringOptional
sortstringOptional
orderstringOptional
namestringOptional
urlstringOptional
event_typestringOptional
is_activestringOptional
is_test_modestringOptional
payload_formatstringOptional
has_failuresstringOptional
last_delivery_fromstringOptional
last_delivery_tostringOptional
delivery_rate_minstringOptional
delivery_rate_maxstringOptional
querystringOptional

Response body

Success response 200 · schema WebhookListResponseV1

dataarray of WebhookRecordV1Required
itemsobject
webhook_idstring <uuid>Required
tenantstring <uuid>Required
namestringRequired
descriptionstringRequiredNullable
urlstringRequired
methodstringRequired
Enum: GETPOSTPUTPATCHDELETE
event_typesarray of WebhookEventTypeV1Required
itemsstring
Enum: ticket.createdticket.updatedticket.status_changedticket.assignedticket.closedticket.comment.addedproject.createdproject.updatedproject.completedproject.task.createdproject.task.updatedproject.task.completedclient.createdclient.updatedcontact.createdcontact.updatedtime.entry.createdtime.entry.updatedtime.entry.approvedinvoice.createdinvoice.finalizedinvoice.sentinvoice.paidasset.createdasset.updatedasset.maintenance.scheduledasset.maintenance.completedsystem.backup.completedsystem.backup.failedsystem.maintenance.startedsystem.maintenance.completedworkflow.execution.startedworkflow.execution.completedworkflow.execution.failedcustom.event
securityobjectNullable
payload_formatstring
Enum: jsonxmlform_datacustom
content_typestring
custom_headersobjectRequiredNullable
event_filterobjectNullable
payload_fieldsobjectNullable
Per-entity payload allowlist. null/{} = full payload everywhere. { ticket: null } = full ticket payload. { ticket: [] } = required-only. { ticket: [a,b] } = explicit allowlist plus required keys. Validated against WEBHOOK_PAYLOAD_FIELDS_BY_ENTITY in webhookSchemas.
payload_transformationobjectNullable
retry_configobjectNullable
is_activebooleanRequired
is_test_modeboolean
verify_sslbooleanRequired
total_deliveriesintegerRequired
successful_deliveriesintegerRequired
failed_deliveriesintegerRequired
last_delivery_atstring <date-time>Nullable
last_success_atstring <date-time>Nullable
last_failure_atstring <date-time>Nullable
auto_disabled_atstring <date-time>Nullable
created_atstring <date-time>Required
updated_atstring <date-time>Required
tagsarray of string
itemsstring
paginationobjectRequired
pageintegerRequired
limitintegerRequired
totalintegerRequired
totalPagesintegerRequired
hasNextbooleanRequired
hasPrevbooleanRequired
metaobject

Response codes

200
Paginated webhook list.
400
Invalid request payload, query, or webhook id format.
401
API key missing/invalid or key user missing.
403
Webhook RBAC permission denied.
500
Unexpected webhook operation failure.