Tracking & events

Poll tracking events after a cursor

An append-only feed of gift events, oldest first: send.link_opened (a recipient opened their gift link), send.auto_approved (a playbook's auto-approve rule approved and paid for a gift), status, link, order, tracking and outcome changes. Start without cursor, store nextCursor after every poll (it is always set) and keep the same filters; hasMore says whether to poll again now. Test and live events share the feed: read mode. playbook.person_waiting is a webhook-only event.

get/events

Request

  • Base URL: https://gtmswag.com/api/v1
  • URL: https://gtmswag.com/api/v1/events
  • Auth: HTTP bearer

Query parameters

campaignIdstring

Campaign ID (cmp_): a saved campaign or playbook.

externalIdstring

External record ID (recipient contact ID).

status'awaiting_address' | 'queued' | 'in_production' | 'shipped' | 'delivered' | 'cancelled'

Delivery status to include.

sendIdstring

Send ID (send_): one gift (send), not a campaign.

limitinteger

Maximum records in this page, from 1 to 100.

cursorstring

Prior event nextCursor; keep filters unchanged when polling.

type'send.created' | 'send.gift_link_changed' | 'send.order_changed' | 'send.address_confirmed' | 'send.link_opened' | 'send.status_changed' | 'send.outcome_reported' | 'send.tracking_changed' | 'send.auto_approved'

Tracking event type to include.

Response

Success: {"data": TrackingEventsPage}.

Changes

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