Swap succeeded

Fired when all steps of a wallet action have been confirmed onchain. The action is complete.

postWebhookwallet_action.swap.succeeded

Payload

type'wallet_action.swap.succeeded' required

The type of webhook event.

reference_idstring nullable

Developer-provided reference ID, if one was included in the request.

wallet_action_idstring required

The ID of the wallet action.

wallet_idstring required

The ID of the wallet involved in the action.

action_type'swap' | 'transfer' | 'earn_deposit' | 'earn_withdraw' | 'earn_incentive_claim' | 'earn_fee_collect' | 'payout' required

Type of wallet action

created_atstring required

ISO 8601 timestamp of when the wallet action was created.

caip2string required

Chain identifier.

input_tokenstring required

Token address being sold.

output_tokenstring required

Token address being bought.

input_amountstring nullable required

Amount of input token in base units. Populated after onchain confirmation.

output_amountstring nullable required

Amount of output token received, in base units. Populated after onchain confirmation.

status'succeeded' required

The status of the wallet action.

completed_atstring required

ISO 8601 timestamp of when the wallet action completed successfully.

Example payload

{
  "steps": [
    {
      "gas_credits_charged": {
        "value": "100.00",
        "currency": "usd"
      }
    }
  ]
}

Response

Return a 200 status to indicate that the webhook was received successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.