Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Test webhook endpoint

POST /api/v1/webhook-endpoints/{endpointId}/test

Send one signed test delivery through the endpoint delivery path. Test deliveries are not retried automatically.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

endpointIdrequired

string

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/webhook-endpoints/00000000-0000-4000-8000-000000000000/test" \
  -H "Authorization: Bearer $PIPELINE_API_KEY"

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "deliveryId": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "deliveryId"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.