Webhook Relay

List relay events

Returns inbound webhook events the relay has received. Each row is one delivery from an upstream platform. Filter by connection, platform, event type, or a time range.

get/v1/webhooks/relay/events

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/webhooks/relay/events
  • Auth: API key in header X-One-Secret

Query parameters

limitinteger

Items per page. Default 20, hard-capped at 150. limit=0 is treated as 1. Larger values silently clamp.

pageinteger

Page number for pagination (1-indexed). Defaults to 1.

skipinteger

Number of items to skip before the first returned item. Defaults to 0. Most callers should leave this at 0 and rely on page + limit.

connectionIdstring uuid

Restrict to relay events received on the given connection.

platformstring

Restrict to relay events for the given upstream platform (e.g. stripe, hubspot).

eventTypestring

Restrict to relay events of the named upstream event type.

afterstring

ISO-8601 timestamp — return only events received at or after this time.

beforestring

ISO-8601 timestamp — return only events received at or before this time.

Response

Paginated list of relay events

pageinteger required
pagesinteger required
totalinteger required

Changes

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