CreateWebhookSubscription_SubscriptionInput
Input object

The details of the webhook subscription to be created.

Fields

Name
Description
eventTypeCode* 
String!
The type of event to subscribe to.See Event implementations for a list of supported values.
schemeId* 
String!
The scheme ID of the event.Currently, only seekAnz and seekAnzPublicTest are supported.
signingAlgorithmCode* 
String!
The algorithm for signing webhooks.Currently, two codes are defined:
  • None indicates no signature will be attached.
  • SeekHmacSha512 indicates a HMAC SHA-512 hex digest will be attached to each request as a Seek-Signature header.
A webhook's signature can be used to validate that the request originated from SEEK.Use a constant-time algorithm to validate the signature. Regular comparison methods like the == operator are susceptible to timing attacks.
url* 
String!
The subscriber-owned URL where events will be sent to.
hirerId 
String
The optional hirer ID to receive events from.By default webhook subscriptions will send events from all hirers the partner has access to. Providing a hirer ID will filter events to the specified hirer.
maxEventsPerAttempt 
Int
The maximum number of events that will be sent in each HTTP request.This number must be between 1 and 10 inclusive. Defaults to 10.
secret 
String
The secret for signing webhooks.This must be specified if signingAlgorithmCode is not None. It is used as the key to generate a message authentication code for each request.The secret should be a random string with high entropy that is not reused for any other purpose.This field has a maximum length of 255 bytes in UTF-8 encoding.

Seen in

Parent name
Parent type
Description
Input Object
webhookSubscription field