sdkDeterministic

Test webhook endpoint

Name: Pipeline
Price: 99 USD

pipeline.testWebhookEndpoint

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

TypeScripttypescript

await pipeline.testWebhookEndpoint({
  "endpointId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema

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

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.