Testing & Sandbox
Sandbox

Trigger a Webhook

Changed on

Triggers a callback previously registered for webhooks. Use this endpoint to emit a webhook for testing in the Sandbox environment. This endpoint will respond with a 404 outside of the Sandbox environment.

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.
post/v1/sandbox/webhook-callbacks/trigger

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/sandbox/webhook-callbacks/trigger
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token)

Request body

OR

Example request

{
  "employment_id": "e966a8b8-1076-11ee-a5f2-9b3997a968f6",
  "event_type": "employment.onboarding_task.completed"
}

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

  • 6962720cf7e8Revision changes
    • 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
    • info

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