Updates a subscription for an event

This endpoint takes in a callback URL, and a list of event types that you would like to receive updates for. During this request, HCSS will make a GET request to your callback URL with a query parameter called "challenge". Your endpoint must return a 200 OK with the challenge in the response. Once your callback URL has successfully responded to the challenge, you will begin to receive POST requests to the same URL. Information regarding the shape of these POST requests can be seen in the "Callbacks" section below.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

The callback URL. This is where the webhook notifications will be sent.

eventTypes
array of objects

The available event types for subscription. You can subscribe to either one or all of the events.

eventTypes
Allowed:
string

The optional secret key. This key is used to calculate hash of the response payload and included in the header.
If not provided, HCSS will generate a random key and include it in the response.

jobIds
array of strings | null

The optional job guids. If provided only events pertaining to these jobs will be notified. If you want to get notified for all the jobs, do not include JobIds in the request. It is possible to subscribe to more than 1 job.

jobIds
Responses

Callbacks
Language
Credentials
OAuth2
Required Scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json