Integrations
Webhooks

List Webhook Callbacks

Changed on

List callbacks for a given company

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)View webhooks (webhook:read)Manage webhooks (webhook:write)
get/v1/companies/{company_id}/webhook-callbacks

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/companies/{company_id}/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:read, webhook:write, company_admin, all:write, all:read)

Path parameters

company_idstring required

Company ID

Response

Success

Example response

{
  "data": [
    {
      "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

  • 5f19187c7589Revision changes
    • warning

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