POST/api/v1/webhooks/{id}/test

Test webhook by id

Sends a signed test delivery to the webhook URL using the stored signing secret and records the attempt in webhook_deliveries with is_test=true.

RBAC · webhook

Path parameters

idstring <uuid>Required

Webhook UUID from webhooks.webhook_id.

Request body

Content type: application/json · schema WebhookTestBodyV1

webhook_idstring <uuid>

test_event_typestringRequired

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

test_payloadobject

override_urlstring <uri>

Response body

Success response 200 · schema WebhookTestResultEnvelopeV1

dataobjectRequired

test_idstring <uuid>Required

event_id stamped on the test envelope.

delivery_idstring <uuid>Required

successbooleanRequired

status_codeintegerNullable

response_time_msintegerNullable

response_bodystringNullable

error_messagestringNullable

tested_atstring <date-time>Required

metaobject

Response codes

200

Test delivery executed.

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.

POST /api/v1/webhooks/{id}/test

cURL

curl -X POST "https://algapsa.com/api/v1/webhooks/{id}/test" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "webhook_id": "01HN2K7VRB9PQ3Y0000000000",
  "test_event_type": "ticket.created",
  "test_payload": {},
  "override_url": "https://example.com"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/webhooks/{id}/test", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "webhook_id": "01HN2K7VRB9PQ3Y0000000000",
    "test_event_type": "ticket.created",
    "test_payload": {},
    "override_url": "https://example.com"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/webhooks/{id}/test");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""webhook_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""test_event_type"": ""ticket.created"",
  ""test_payload"": {},
  ""override_url"": ""https://example.com""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "test_id": "01HN2K7VRB9PQ3Y0000000000",
    "delivery_id": "01HN2K7VRB9PQ3Y0000000000",
    "success": false,
    "status_code": 1,
    "response_time_ms": 1,
    "response_body": "string",
    "error_message": "string",
    "tested_at": "2026-04-18T15:22:14Z"
  },
  "meta": {}
}