API reference · Inbound Webhooks
POST/api/v1/inbound-webhooks
Product availabilityAlgaPSA

Create inbound webhook

Creates an inbound webhook configuration and returns any one-time generated secret.

RBAC · inbound_webhook

Request body

Content type: application/json · schema InboundWebhookCreateInput

namestringRequired
min length 1
slugstringRequired
pattern /^[a-z0-9][a-z0-9-]*[a-z0-9]$|^[a-z0-9]$/
descriptionstringNullable
auth_typestringRequired
Enum: hmac_sha256bearerip_allowlistpath_token
auth_configobjectRequired
idempotency_sourceobjectNullable
typestringRequired
Enum: headerjsonata
valuestringRequired
idempotency_window_secondsinteger
handler_typestringRequired
Enum: direct_actionworkflow
handler_configobjectRequired
is_activeboolean
rate_limit_per_minuteinteger

Response body

Success response 201

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

201
Inbound webhook created.
400
Invalid inbound webhook request.
401
Missing or invalid authenticated user context.
403
Inbound webhook permission denied.
409
Inbound webhook slug already exists.
500
Unexpected inbound webhook operation failure.