Sandbox
Trigger a Webhook
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 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.
post/v1/sandbox/webhook-callbacks/trigger
Request
- Base URLhttps://gateway.remote.com
- URLhttps://gateway.remote.com/v1/sandbox/webhook-callbacks/trigger
- Auth
- OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token
- or HTTP bearer
Request body
Example request
{
"employment_id": "e966a8b8-1076-11ee-a5f2-9b3997a968f6",
"event_type": "employment.onboarding_task.completed"
}Response
Success
Example response
{
"data": {
"status": "ok"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.