Skip to main content
GET
Retrieve a success event

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Path Parameters

event_id
string
required

Unique identifier for a success event.

Pattern: ^sev_[0-9a-f]{32}$
Example:

"sev_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

One entry in the success-event ledger.

billable
boolean
required

Whether a billing agreement was attached when the event was recorded. false means the event is kept for reporting but will never be invoiced, even if an agreement starts later.

created_at
string<date-time>
required

When Sailer recorded the event.

currency
string
required
Example:

"BRL"

dedupe_key
string
required
entry_kind
enum<string>
required

record for a success; reversal for the entry that undoes one. A reversal carries the same event_code and value_cents as the event it reverses.

Available options:
record,
reversal
event_code
string
required
id
string
required

Unique identifier for a success event.

Pattern: ^sev_[0-9a-f]{32}$
Example:

"sev_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

occurred_at
string<date-time>
required
agreement_id
string | null

Unique identifier for a billing agreement.

Pattern: ^agr_[0-9a-f]{32}$
Example:

"agr_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

contact_id
string | null

Unique identifier for a contact.

Pattern: ^con_[0-9a-f]{32}$
Example:

"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

conversation_id
string | null

Unique identifier for a conversation.

Pattern: ^conv_[0-9a-f]{32}$
Example:

"conv_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

deal_id
string | null

Unique identifier for a deal.

Pattern: ^deal_[0-9a-f]{32}$
Example:

"deal_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

object
string
default:success_event
Allowed value: "success_event"
reason
string | null
reverses_event_id
string | null

Unique identifier for a success event.

Pattern: ^sev_[0-9a-f]{32}$
Example:

"sev_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

value_cents
integer | null