API reference · Webhooks
PUT/api/v1/webhooks/templates/{id}
Product availabilityAlgaPSA

Update webhook template (webhook update wiring)

Template update route delegates to ApiWebhookController.update() and operates on webhooks rows, not webhook_templates.

RBAC · webhook

Path parameters

idstring <uuid>Required
Webhook UUID from webhooks.webhook_id.

Request body

Content type: application/json · schema CreateWebhookBodyV1

namestringRequired
min length 1
descriptionstring
urlstring <uri>Required
methodstring
Enum: GETPOSTPUTPATCHDELETE
event_typesarray of WebhookEventTypeV1Required
min items 1
itemsstring
Enum: ticket.createdticket.updatedticket.status_changedticket.assignedticket.closedticket.comment.addedproject.createdproject.updatedproject.status_changedproject.assignedproject.closedproject.completedproject.task.createdproject.task.updatedproject.task.status_changedproject.task.assignedproject.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
securityobject
payload_formatstring
Enum: jsonxmlform_datacustom
content_typestring
custom_headersobject
event_filterobject
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. Unknown entities and fields are rejected by WEBHOOK_PAYLOAD_FIELDS_BY_ENTITY in lib/webhooks/payloadFields. Supported fields: ticket: ticket_number, title, url, status_id, status_name, is_closed, previous_status_id, previous_status_name, priority_id, priority_name, client_id, client_name, contact_name_id, contact_name, contact_email, assigned_to, assigned_to_name, assigned_team_id, board_id, board_name, category_id, subcategory_id, entered_at, updated_at, closed_at, due_date, tags, comment, changes, comments; project: project_name, wbs_code, description, status_id, status_name, is_closed, previous_status_id, previous_status_name, client_id, client_name, contact_name_id, contact_name, contact_email, assigned_to, assigned_to_name, start_date, end_date, budgeted_hours, url, changes, phases, task_counts, task_id, phase_id, phase_name, task_name, estimated_hours, actual_hours, due_date, priority_id, priority_name, tags.
ticketarray of stringNullable
itemsstring
Enum: ticket_numbertitleurlstatus_idstatus_nameis_closedprevious_status_idprevious_status_namepriority_idpriority_nameclient_idclient_namecontact_name_idcontact_namecontact_emailassigned_toassigned_to_nameassigned_team_idboard_idboard_namecategory_idsubcategory_identered_atupdated_atclosed_atdue_datetagscommentchangescomments
projectarray of stringNullable
itemsstring
Enum: project_namewbs_codedescriptionstatus_idstatus_nameis_closedprevious_status_idprevious_status_nameclient_idclient_namecontact_name_idcontact_namecontact_emailassigned_toassigned_to_namestart_dateend_datebudgeted_hoursurlchangesphasestask_countstask_idphase_idphase_nametask_nameestimated_hoursactual_hoursdue_datepriority_idpriority_nametags
payload_transformationobject
retry_configobject
is_activeboolean
is_test_modeboolean
verify_sslboolean
secret_tokenstring
rate_limitobject
metadataobject
tagsarray of string
itemsstring

Response body

Success response 200 · schema WebhookEnvelopeV1

dataobjectRequired
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.status_changedproject.assignedproject.closedproject.completedproject.task.createdproject.task.updatedproject.task.status_changedproject.task.assignedproject.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. Unknown entities and fields are rejected by WEBHOOK_PAYLOAD_FIELDS_BY_ENTITY in lib/webhooks/payloadFields. Supported fields: ticket: ticket_number, title, url, status_id, status_name, is_closed, previous_status_id, previous_status_name, priority_id, priority_name, client_id, client_name, contact_name_id, contact_name, contact_email, assigned_to, assigned_to_name, assigned_team_id, board_id, board_name, category_id, subcategory_id, entered_at, updated_at, closed_at, due_date, tags, comment, changes, comments; project: project_name, wbs_code, description, status_id, status_name, is_closed, previous_status_id, previous_status_name, client_id, client_name, contact_name_id, contact_name, contact_email, assigned_to, assigned_to_name, start_date, end_date, budgeted_hours, url, changes, phases, task_counts, task_id, phase_id, phase_name, task_name, estimated_hours, actual_hours, due_date, priority_id, priority_name, tags.
ticketarray of stringNullable
itemsstring
Enum: ticket_numbertitleurlstatus_idstatus_nameis_closedprevious_status_idprevious_status_namepriority_idpriority_nameclient_idclient_namecontact_name_idcontact_namecontact_emailassigned_toassigned_to_nameassigned_team_idboard_idboard_namecategory_idsubcategory_identered_atupdated_atclosed_atdue_datetagscommentchangescomments
projectarray of stringNullable
itemsstring
Enum: project_namewbs_codedescriptionstatus_idstatus_nameis_closedprevious_status_idprevious_status_nameclient_idclient_namecontact_name_idcontact_namecontact_emailassigned_toassigned_to_namestart_dateend_datebudgeted_hoursurlchangesphasestask_countstask_idphase_idphase_nametask_nameestimated_hoursactual_hoursdue_datepriority_idpriority_nametags
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
metaobject

Response codes

200
Webhook updated.
400
Invalid request payload, query, or webhook id format.
401
API key missing/invalid or key user missing.
403
Webhook RBAC permission denied.
404
Webhook, delivery, template, or signing secret not found.
500
Unexpected webhook operation failure.