Skip to main content
WEBHOOK

Body

application/json

Payload delivered for the transaction.earn_reward webhook event.

type
string
required

Webhook event identifier.

Allowed value: "transaction.earn_reward"
transaction_id
string
required

Public transaction identifier.

user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42
account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
timestamp
string<date-time>
required

Time at which the event was observed.

status
enum<string>

Current public portfolio transaction status.

Available options:
uncategorized,
in_progress,
successful,
failed
spend
PortfolioTransactionAmount · object

Asset spent by this transaction.

receive
PortfolioTransactionAmount · object

Asset received by this transaction.

details
PortfolioTransactionEarnRewardDetails · object

Earn-reward-specific transaction details.

Response

2XX

Delivery endpoint accepted the webhook.