SMsmartrecruiters
subscriptions

Subscribe to a webhook.

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.

post/subscriptions

Request

  • Base URL
    https://api.smartrecruiters.com/webhooks-api/v201907
  • URL
    https://api.smartrecruiters.com/webhooks-api/v201907/subscriptions
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: webhooks_write, webhooks_manage

Request body

namestring nullable
descriptionstring nullable
callbackUrlstring https_url required
eventsEventName[] required
alertingEmailAddressstring email

Example request

{
  "callbackUrl": "https://server.com/send/callback/here",
  "alertingEmailAddress": "webhook.alerts@domain.com",
  "callbackAuthentication": {
    "type": "basic",
    "username": "basic-user",
    "password": "jVG8wzKZ%B+r_NkA"
  }
}

Response

Webhook subscription created.

idstring
namestring nullable
descriptionstring nullable
callbackUrlstring https_url required
status'inactive' | 'active'

Example response

{
  "callbackUrl": "https://server.com/send/callback/here"
}

Changes

No recorded changes to this operation across all 1 revision of this API.