API reference · Inbound Webhooks
POST/api/v1/inbound-webhooks/{id}/capture-sample
Product availabilityAlgaPSA

Enable inbound webhook sample capture

Enables capture mode so the next verified request stores its body as the sample payload.

RBAC · inbound_webhook

Path parameters

idstring <uuid>Required
Inbound webhook UUID.

Response body

Success response 200

dataobjectRequired
inboundWebhookIdstring <uuid>Required
tenantstring <uuid>Required
namestringRequired
slugstringRequired
descriptionstringRequiredNullable
authTypestringRequired
Enum: hmac_sha256bearerip_allowlistpath_token
authConfigobjectRequired
Redacted auth configuration metadata.
idempotencySourceobjectRequiredNullable
typestringRequired
Enum: headerjsonata
valuestringRequired
idempotencyWindowSecondsintegerRequired
handlerTypestringRequired
Enum: direct_actionworkflow
handlerConfigobjectRequired
samplePayloadany
sampleCaptureExpiresAtstring <date-time>RequiredNullable
isActivebooleanRequired
rateLimitPerMinuteintegerRequired
autoDisabledAtstring <date-time>RequiredNullable
createdBystring <uuid>RequiredNullable
createdAtstring <date-time>Required
updatedAtstring <date-time>Required
secretstringNullable

Response codes

200
Sample capture enabled.
400
Invalid inbound webhook request.
401
Missing or invalid authenticated user context.
403
Inbound webhook permission denied.
404
Inbound webhook not found.
500
Unexpected inbound webhook operation failure.