Webhook

Basic data for every webhooks.

Every webhook is a POST with a JSON body and these headers:

Request Header

{
  "CALLBACK-TOKEN": "secretcallbacktoken",
  "USER-AGENT": "Monit"
}

Refuse the request if CALLBACK-TOKEN does not match your callback token. You can change the token on your Monit dashboard.

Every webhook body has the same fields:

Example

{
  "event_id": "0bae6dfc-8200-009e-9c16-c149ce5b019b",
  "timestamp": "2022-12-13 10:03:39",
  "event_type": "TRANSACTION",
  "event_detail": "NEW_TRANSACTION",
  "is_sandbox": false,
  "organization_id": "0b5a1e02-3c00-0011-8d2e-7a1f3b9c4d10",
  "data": {}
}

Field	Type	Description
event_id	String UUID	Unique for every event. Retries of the same event keep the same event_id.
timestamp	Datetime	When the event was created, format yyyy-mm-dd HH:MM:SS, time zone UTC.
event_type	String	Event type. See below.
event_detail	String	Event detail. See below.
is_sandbox	Boolean	true for sandbox events.
organization_id	String UUID	Your organization's identifier.
data	Object	Event data. See the page for each event.

Event type and detail

event_type	event_detail	Sent when
TRANSACTION	NEW_TRANSACTION	A transaction is created, such as a card transaction, a transfer between accounts, a new card, or a card cancellation refund.
TRANSACTION	UPDATED_TRANSACTION	A transaction's status changes, for example after a payment.
TRANSACTION	DECLINED_TRANSACTION	A card transaction is declined. See Declined Transaction.
PAYMENT	PAYMENT_PROCESSED	A payment is processed.
ACCOUNT	ACCOUNT_ACTIVE	An account becomes active.
CARD	CARD_ACTIVE	A card becomes active.
CARD	CARD_FROZEN	A card is frozen.
CARD	REQUEST_3DS	A cardholder gets a 3D Secure challenge. Sent only to your OTP callback URL. See Card 3DS OTP.
CARD	REQUEST_3DS_TEST	A test REQUEST_3DS event sent from your Monit dashboard. Sent only to your OTP callback URL.