Integrations
Webhooks

Update a Webhook Callback

Changed on

Update a callback previously registered for webhooks

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
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: 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)

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

  • 6962720cf7e8Revision changes
    • warning

      added the new contractor_invoice.funds_returned enum value to the /// response property for the response status

    • warning

      added the new contractor_invoice.pay_out_failed enum value to the /// response property for the response status

    • info

      added the new contractor_invoice.funds_returned enum value to the request property /

    • info

      added the new contractor_invoice.pay_out_failed enum value to the request property /

  • 5f19187c7589Revision changes
    • warning

      added the new company.hard_deleted enum value to the /// response property for the response status

    • info

      added the new company.hard_deleted enum value to the request property /