API ReferenceEvent Subscriptions

Create subscription

Creates an active webhook subscription and returns its generated signing secret. - The Public API returns the secret only in this response. - Delivery to `endpointUrl` starts immediately. - Each workspace can have up to 50 subscriptions.

Authentication

Authorizationstring

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

Request

This endpoint expects an object.
endpointUrlstringRequiredformat: "^https://.+$"0-2048 characters

HTTPS URL Plextera POSTs events to. Plain http, embedded user credentials, and fragments are rejected. Maximum length: 2048 characters.

eventTypeslist of enumsRequired
Event types to deliver. At least one is required.
namestringOptional1-128 characters

Optional human-readable name used to distinguish subscriptions. When provided, it must not be blank; surrounding whitespace is removed. Maximum length: 128 characters.

filtersobjectOptional

Optional delivery filters. Currently supports workflowId for workflow events.

Response headers

Cache-ControlstringOptional
Prevents storage of webhook configuration, payload, and diagnostic responses.

Response

Subscription created and active. Includes the server-generated signing secret in this Public API response.

idstring
Subscription identifier.
statusenum

active after creation.

endpointUrlstring
HTTPS URL events are delivered to.
eventTypeslist of enums
Event types this subscription receives.
createdAtdatetime
UTC timestamp when the subscription was created.
updatedAtdatetime
UTC timestamp of the last subscription change.
signingSecretstring

Server-generated 256-bit secret used to verify webhook signatures. The Public API returns it only in the successful create response and has no reveal operation; authorized Plextera dashboard users can explicitly reveal the current secret. Store it securely. Plextera sends X-Plextera-Signature as t=<unix timestamp>,v1=<HMAC-SHA256(timestamp + '.' + raw request body)>.

namestringOptional

Optional human-readable name used to distinguish subscriptions.

filtersobjectOptional
Delivery filters. Omitted when none are configured.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error