REremote-com
Webhook Events

List Webhook Events

List all webhook events

Authentication

This endpoint requires the following token type:

  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.

Scopes

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

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Client credentials access tokenManage company resources (company_admin)View webhooks (webhook:read)Manage webhooks (webhook:write)
get/v1/webhook-events

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/webhook-events
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: webhook:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write

Query parameters

event_typestring

Filter by webhook event type

successfully_deliveredboolean

Filter by delivery status (true = 200, false = 4xx/5xx)

company_idstring

Filter by company ID

beforestring

Filter by date before (ISO 8601 format)

afterstring

Filter by date after (ISO 8601 format)

order'asc' | 'desc'

Sort order

sort_by'first_triggered_at'

Field to sort by

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "total_count": 1,
  "total_pages": 1,
  "webhook_events": [
    {
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "timesheet.created",
      "first_triggered_at": "2025-01-01T00:00:00Z",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "last_triggered_at": "2025-01-02T00:00:00Z",
      "successfully_delivered": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.