Skip to main content
WEBHOOK

Authorizations

X-RAMPNOW-API-KEY
string
header
required

Partner API key sent in the X-RAMPNOW-API-KEY header. Every request must ALSO send X-RAMPNOW-TIMESTAMP (unix seconds) and X-RAMPNOW-SIGN (hex HMAC-SHA256 of timestamp + METHOD + requestURI + rawBody, keyed with your API secret). See the Authentication guide.

Body

application/json

Webhook is the envelope Rampnow POSTs to your webhook endpoint. payload is event-specific — see the concrete payload struct for each eventType (e.g. RampOrderStatusChangeWebhook for ramp_order.status_change). Use eventUid for idempotent processing.

createdAt
string<date-time>
required

When the webhook event was generated (UTC)

eventType
string
required

Event kind, e.g. ramp_order.status_change

eventUid
string
required

Unique event ID; use for deduplication across retries

payload
object
required

Event-specific payload; shape depends on eventType

Response

200

OK