Subscription creation, updates, status, alerts, and lifecycle operations.
Make your first request
Use this guide to move from authentication to a valid Subscription API request, then open each endpoint guide for the full request and response details.
Get an access token
Use the authentication flow for your workspace and send the token as a Bearer credential.
Read the response
Check the status, content type, and documented response fields before processing results.
PUT /subscriptions/job
Endpoint guides explain URL parameters, headers, request bodies, and required values.
Endpoint guides pair a response example with the generated technical schema so implementation and validation stay together.
Subscription API
Create, monitor, and manage subscription jobs, alert delivery, and subscribed entity data through a consistent two-level reference experience.
Overview
The Subscription API supports the lifecycle around subscription configuration and delivery. Use the overview below to choose the right operation, then open a child page for the exact endpoint request, response, and schema details.
Manage subscriptions
List, inspect, update, and delete subscriptions using the operations in the core group.
Monitor delivery
Review alerts, entity IDs, and job status to understand what the subscription is delivering and how processing is progressing.
Use job workflows
Persist job IDs and poll job status so asynchronous subscription changes are observable and recoverable.
Subscription lifecycle
A typical integration lists or retrieves a subscription, submits any required change job, and monitors the job through completion. Alert and entity operations provide the supporting visibility needed to reconcile downstream state.
The endpoint pages below define the required subscription IDs, alert IDs, job IDs, request bodies, and response schemas for each lifecycle step.
Endpoint tech specs
Operations are grouped by the workflow they support.
Core subscription operations
List subscriptions
List the subscriptions available for the current client context.
View endpoint tech specs →Get subscription details
Retrieve the configuration and current details for one subscription.
View endpoint tech specs →Update subscriptions job
Submit a subscription update job using the generated request schema.
View endpoint tech specs →Delete a subscription
Remove a subscription by ID when the integration no longer needs its delivery.
View endpoint tech specs →Alerts and entities
List subscription alerts
List alerts associated with a subscription.
View endpoint tech specs →Get subscription alert details
Retrieve details for a specific alert associated with a subscription.
View endpoint tech specs →Get subscription entity details
Retrieve the entity IDs associated with a subscription.
View endpoint tech specs →Subscription jobs
Create subscription job
Submit the alternate subscription job operation defined by the API schema.
View endpoint tech specs →Get subscription job status
Poll a subscription job by ID and inspect its processing status.
View endpoint tech specs →List subscription jobs
Review subscription jobs and their current processing information.
View endpoint tech specs →Operational notes
Authentication
Send the required bearer token with every request and protect it from browser code, logs, and client-side storage.
Use returned IDs
Carry subscription, alert, entity, and job IDs between calls exactly as returned by the API.
Handle retries safely
Record request intent and job state so retries do not create unexplained duplicate changes or gaps in downstream delivery.