Webhooks

Create a Webhook Callback

Register a callback to be used for webhooks

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage webhooks (webhook:write)
post/v1/webhook-callbacks

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/webhook-callbacks
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, webhook:write, company_admin, all:write) and OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, webhook:write, company_admin, all:write)

Headers

Authorizationstring required

This endpoint works with any of the access tokens provided. You can use an access token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow.

Request body

subscribe_to_all_eventsboolean

When true, subscribe this callback to all current and future event types. Cannot be combined with subscribed_events.

subscribed_eventsstring[]
urlstring required

Example request

{
  "subscribe_to_all_events": true,
  "url": "https://example.com/callback"
}

Response

Success

Example response

{
  "data": {
    "webhook_callback": {
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "subscribed_events": [
        "employment.onboarding_task.completed"
      ],
      "url": "https://example.com/callback"
    }
  }
}

Changes

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