PUT/api/v1/webhooks/{id}

Product availabilityAlgaPSA

Update webhook

Updates a webhook by id. Body accepts the same fields as create, all optional.

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

Public webhook event name from the single event registry (ticket.*, project.*, client.*, contact.*, client_location.*). Webhooks created earlier may still store retired names (time.entry.*, invoice.*, asset.*, system.*, workflow.*, custom.event); those are returned as stored, never deliver, and are rejected when newly added.

Enum: ticket.createdticket.updatedticket.assignedticket.status_changedticket.closedticket.comment.addedticket.response_state_changedproject.createdproject.updatedproject.status_changedproject.assignedproject.closedproject.completedproject.task.createdproject.task.updatedproject.task.status_changedproject.task.assignedproject.task.completedclient.createdclient.updatedclient.deactivatedclient.deletedcontact.createdcontact.updatedcontact.deactivatedcontact.deletedclient_location.createdclient_location.updatedclient_location.deactivatedclient_location.deleted

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, response_state, previous_status_id, previous_status_name, previous_response_state, new_response_state, 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; client: changed_fields; contact: client_id, changed_fields; client_location: client_id, changed_fields.

ticketarray of stringNullable

itemsstring

Enum: ticket_numbertitleurlstatus_idstatus_nameis_closedresponse_stateprevious_status_idprevious_status_nameprevious_response_statenew_response_statepriority_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

clientarray of stringNullable

itemsstring

Enum: changed_fields

contactarray of stringNullable

itemsstring

Enum: client_idchanged_fields

client_locationarray of stringNullable

itemsstring

Enum: client_idchanged_fields

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 stringRequired

Event names as stored; may include retired legacy names (inert).

itemsstring

securityobjectNullable

payload_formatstring

Enum: jsonxmlform_datacustom

content_typestring

custom_headersobjectRequiredNullable

event_filterobjectNullable

payload_fieldsobjectNullable

ticketarray of stringNullable

itemsstring

projectarray of stringNullable

itemsstring

clientarray of stringNullable

itemsstring

Enum: changed_fields

contactarray of stringNullable

itemsstring

Enum: client_idchanged_fields

client_locationarray of stringNullable

itemsstring

Enum: client_idchanged_fields

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.

PUT /api/v1/webhooks/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/webhooks/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "x",
  "description": "string",
  "url": "https://example.com",
  "method": "GET",
  "event_types": [
    "ticket.created"
  ],
  "security": {},
  "payload_format": "json",
  "content_type": "string",
  "custom_headers": {},
  "event_filter": {},
  "payload_fields": {
    "ticket": [
      "ticket_number"
    ],
    "project": [
      "project_name"
    ],
    "client": [
      "changed_fields"
    ],
    "contact": [
      "client_id"
    ],
    "client_location": [
      "client_id"
    ]
  },
  "payload_transformation": {},
  "retry_config": {},
  "is_active": false,
  "is_test_mode": false,
  "verify_ssl": false,
  "secret_token": "string",
  "rate_limit": {},
  "metadata": {},
  "tags": [
    "string"
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/webhooks/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "x",
    "description": "string",
    "url": "https://example.com",
    "method": "GET",
    "event_types": [
      "ticket.created"
    ],
    "security": {},
    "payload_format": "json",
    "content_type": "string",
    "custom_headers": {},
    "event_filter": {},
    "payload_fields": {
      "ticket": [
        "ticket_number"
      ],
      "project": [
        "project_name"
      ],
      "client": [
        "changed_fields"
      ],
      "contact": [
        "client_id"
      ],
      "client_location": [
        "client_id"
      ]
    },
    "payload_transformation": {},
    "retry_config": {},
    "is_active": false,
    "is_test_mode": false,
    "verify_ssl": false,
    "secret_token": "string",
    "rate_limit": {},
    "metadata": {},
    "tags": [
      "string"
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/webhooks/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""name"": ""x"",
  ""description"": ""string"",
  ""url"": ""https://example.com"",
  ""method"": ""GET"",
  ""event_types"": [
    ""ticket.created""
  ],
  ""security"": {},
  ""payload_format"": ""json"",
  ""content_type"": ""string"",
  ""custom_headers"": {},
  ""event_filter"": {},
  ""payload_fields"": {
    ""ticket"": [
      ""ticket_number""
    ],
    ""project"": [
      ""project_name""
    ],
    ""client"": [
      ""changed_fields""
    ],
    ""contact"": [
      ""client_id""
    ],
    ""client_location"": [
      ""client_id""
    ]
  },
  ""payload_transformation"": {},
  ""retry_config"": {},
  ""is_active"": false,
  ""is_test_mode"": false,
  ""verify_ssl"": false,
  ""secret_token"": ""string"",
  ""rate_limit"": {},
  ""metadata"": {},
  ""tags"": [
    ""string""
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "webhook_id": "01HN2K7VRB9PQ3Y0000000000",
    "tenant": "01HN2K7VRB9PQ3Y0000000000",
    "name": "string",
    "description": "string",
    "url": "string",
    "method": "GET",
    "event_types": [
      "string"
    ],
    "security": {},
    "payload_format": "json",
    "content_type": "string",
    "custom_headers": {},
    "event_filter": {},
    "payload_fields": {
      "ticket": [
        "ticket_number"
      ],
      "project": [
        "project_name"
      ],
      "client": [
        "changed_fields"
      ],
      "contact": [
        "client_id"
      ],
      "client_location": [
        "client_id"
      ]
    },
    "payload_transformation": {},
    "retry_config": {},
    "is_active": false,
    "is_test_mode": false,
    "verify_ssl": false,
    "total_deliveries": 1,
    "successful_deliveries": 1,
    "failed_deliveries": 1,
    "last_delivery_at": "2026-04-18T15:22:14Z",
    "last_success_at": "2026-04-18T15:22:14Z",
    "last_failure_at": "2026-04-18T15:22:14Z",
    "auto_disabled_at": "2026-04-18T15:22:14Z",
    "created_at": "2026-04-18T15:22:14Z",
    "updated_at": "2026-04-18T15:22:14Z",
    "tags": [
      "string"
    ]
  },
  "meta": {}
}