Webhooks

Update a Webhook Callback

Update a callback previously registered for webhooks

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage company resources (company_admin)	-	Manage webhooks (webhook:write)
Company-scoped access token (assertion)	Manage company resources (company_admin)	-	Manage webhooks (webhook:write)
Customer API token	Manage company resources (company_admin)	-	Manage webhooks (webhook:write)

patch/v1/webhook-callbacks/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/webhook-callbacks/{id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: webhook:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: webhook:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

idstring required

Webhook Callback ID

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

Example request

{
  "subscribed_events": [
    "employment.onboarding_task.completed"
  ],
  "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.