subscriptions

Retrieve webhook subscriptions.

get/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_read, webhooks_manage

Query parameters

page_idstring

identifier of the next page of subscriptions

limitinteger

number of elements to return

Response

List of subscription details.

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.