Guides
Webhooks
Signed notifications when a transfer is attested, delivered, needs a claim or fails. Not available yet.
Coming
Webhooks are not available yet. Until they are, follow transfers by polling, as described in Track a transfer.
What is planned
- API keys. Webhooks will need one. Keys will be sent as
Authorization: Bearer <key>, which the SDK already supports through theapiKeyoption ofcreateXebraClient. - Events for each transfer you watch:
transfer.attested,transfer.delivered,transfer.needs_claimandtransfer.failed. Each carries the sameTransferStatusthatGET /v1/transfers/{chain}/{tx}returns. - Signatures in the Standard Webhooks format (
webhook-id,webhook-timestamp,webhook-signature), with a helper in@xebra/sdkto verify them. - At-least-once delivery with retries. Receivers should expect the same event more than once and
ignore repeats by
webhook-id.
This page will be replaced with the full guide when webhooks ship; the changelog will say when.
Until then
import { } from "@xebra/sdk";
const = ();
declare const : string;
// Returns once the transfer is delivered, needs a claim, or failed.
const = await .("stellar", );
.(.);On a server, store the (chain, tx) pairs you are following and poll them with getTransfer on a
schedule, every few seconds while they are pending or delivering.