Create subscription | Plextera Public API

Authentication

Authorizationstring

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

Request

This endpoint expects an object.

endpointUrlstringRequiredformat: "^https://.+$">=1 character

eventTypeslist of enumsRequired

Allowed values:

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)>.

filtersobjectOptional

Response

Created

idstring

statusenum

Allowed values:

endpointUrlstring

eventTypeslist of enums

Allowed values:

filtersobject

createdAtdatetime

updatedAtdatetime

1	curl -X POST https://api.dev.plextera.com/api/public/v1/event-subscriptions \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"endpointUrl": "string",
6	"eventTypes": [
7	"document-insights.job.completed"
8	],
9	"signingSecret": "string"
10	}'

1	{
2	"id": "string",
3	"status": "active",
4	"endpointUrl": "string",
5	"eventTypes": [
6	"document-insights.job.completed"
7	],
8	"filters": {
9	"workflowId": "string",
10	"documentInsightsOperation": "parse"
11	},
12	"createdAt": "2024-01-15T09:30:00Z",
13	"updatedAt": "2024-01-15T09:30:00Z"
14	}