Subscribe to a webhook.

post https://api.smartrecruiters.com/webhooks-api/v201907/subscriptions

Please be aware that before any event is delivered each subscription needs to be activated.

See subscription activation.

We do limit number of subscriptions each subscriber can register. It means that:

individual user can register up to 20 subscriptions
OAuth application can register up to 20 subscriptions on behalf of a single user

Alerting email address and callback authentication properties are optional.

Body Params

callbackUrl

string

required

events

array of strings

required

length ≥ 1

alertingEmailAddress

string

callbackAuthentication

object

Responses

Callbacks

Language

Credentials


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.smartrecruiters.com/webhooks-api/v201907/subscriptions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Webhook subscription created.

400Invalid request query parameters.

403With codes: NO_PERMISSION_TO_MANAGE_WEBHOOKS when no permission to manage webhook subscriptions SUBSCRIPTIONS_LIMIT_EXCEEDED when subscription limit for subscriber is exceeded

422Incorrect subscription data. Provided callback URL is invalid or event name is not found.