Skip to main content
POST
Send a test webhook

Authorizations

x-api-key
string
header
required

Your SideShift Connect API key (sk_live_* or sk_test_*). Generate from Settings → Connect.

Body

application/json
eventType
enum<string>
default:deposit.confirmed
Available options:
deposit.pending,
deposit.confirmed,
deposit.failed,
transfer.completed,
withdrawal.created,
withdrawal.updated,
withdrawal.completed,
withdrawal.failed,
account.risk_flagged
sideshiftAccountId
string

Account id to place in the payload. Defaults to your company id.

externalId
string
amountCents
integer
default:10000
Required range: x >= 1
feeCents
integer
default:0
Required range: x >= 0
netAmountCents
integer

Defaults to amountCents - feeCents.

Required range: x >= 1
depositId
string

deposit.* events only. Minted when omitted.

paymentId
string

The payment, transfer or withdrawal id to echo. Minted when omitted.

status
enum<string>

withdrawal.updated only. Defaults to in_transit.

Available options:
requested,
awaiting_payment,
in_transit,
completed,
failed,
canceled,
denied
metadata
object

Response

The event was delivered and your endpoint answered 2xx

success
boolean
data
object