API ReferenceEvent Subscriptions

Create subscription

Creates a webhook subscription. Plextera starts delivering the selected event types to endpointUrl, signing every request with signingSecret.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Request

This endpoint expects an object.
endpointUrlstringRequiredformat: "^https://.+$">=1 character
HTTPS URL Plextera POSTs events to. Plain http is rejected.
eventTypeslist of enumsRequired
Event types to deliver. At least one is required.
signingSecretstringRequired>=1 character

Shared secret used to sign webhook deliveries. Plextera sends X-Plextera-Signature as t=<unix timestamp>,v1=<HMAC-SHA256(timestamp + ’.’ + raw request body)>. Write-only: never returned by the API.

filtersobjectOptional

Optional delivery filters. Currently supports workflowId for workflow events.

Response

Subscription created and active. Deliveries start with the next matching event.
idstring
Subscription identifier.
statusenum

active subscriptions receive deliveries; paused ones do not.

endpointUrlstring
HTTPS URL events are delivered to.
eventTypeslist of enums
Event types this subscription receives.
filtersobject
Delivery filters. Omitted when none are configured.
createdAtdatetime
UTC timestamp when the subscription was created.
updatedAtdatetime
UTC timestamp of the last subscription change.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
422
Unprocessable Entity Error
500
Internal Server Error