Webhook Setup

We use webhooks to notify your application when an event happens on an object. Most workflows on Fiat Republic are asynchronous and therefore it is extremely useful for you to use appropriate webhooks in your integration (e.g. when a Fiat Account is activated or receives a Payment).

Webhooks can be created and managed via the Developers section on the Dashboard. If you prefer to create them programmatically, you can do so via the Webhooks API.

📘 NOTE: Webhook events will be retried 10 times, with a new attempt occurring every 10 minutes.

Webhook Events

Object	Events
INDIVIDUAL END USER	`INDIVIDUAL_END_USER.CREATED` `INDIVIDUAL_END_USER.LINKED_CRYPTO_WALLETS_UPDATED` `INDIVIDUAL_END_USER.METADATA_UPDATED` `INDIVIDUAL_END_USER.PERSONAL_DETAILS_UPDATED` `INDIVIDUAL_END_USER.STATUS_UPDATED` `INDIVIDUAL_END_USER.UPDATED`
BUSINESS END USER	`BUSINESS_END_USER.BUSINESS_DETAILS_UPDATED` `BUSINESS_END_USER.STATUS_UPDATED` `BUSINESS_END_USER.LINKED_CRYPTO_WALLETS_UPDATED` `BUSINESS_END_USER.METADATA_UPDATED` `BUSINESS_END_USER.CREATED` `BUSINESS_END_USER.UPDATED` `BUSINESS_END_USER.DELETED`
FIAT ACCOUNT	`FIAT_ACCOUNT.BALANCE_UPDATED` `FIAT_ACCOUNT.BANK_DETAILS_UPDATED` `FIAT_ACCOUNT.CREATED` `FIAT_ACCOUNT.LABEL_UPDATED` `FIAT_ACCOUNT.METADATA_UPDATED` `FIAT_ACCOUNT.STATUS_UPDATED` `FIAT_ACCOUNT.TAGS_UPDATED` `FIAT_ACCOUNT.UPDATED`
VIRTUAL ACCOUNT	`VIRTUAL_ACCOUNT.BANK_DETAILS_UPDATED` `VIRTUAL_ACCOUNT.CREATED` `VIRTUAL_ACCOUNT.LABEL_UPDATED` `VIRTUAL_ACCOUNT.METADATA_UPDATED` `VIRTUAL_ACCOUNT.STATUS_UPDATED` `VIRTUAL_ACCOUNT.UPDATED`
PAYMENT	`PAYMENT.CREATED` `PAYMENT.METADATA_UPDATED` `PAYMENT.STATUS_UPDATED` `PAYMENT.UPDATED` `PAYMENT.PROCESSED_PAYMENT_SCHEME_UPDATED`
PAYEE	`PAYEE.CREATED` `PAYEE.DELETED` `PAYEE.STATUS_UPDATED`
RETURN	`RETURN.CREATED` `RETURN.UPDATED` `RETURN.STATUS_UPDATED`

UPDATED events are available for individual params as well as at the object level. For example, a FIAT_ACCOUNT.UPDATED event will be sent for any update on the Fiat Account object whereas a FIAT_ACCOUNT.BALANCE_UPDATED event will only be sent when the balance of a Fiat Account is updated.

Webhook Event Structure

The body of all Webhook events have the following params:

Parameter	Description
`id`	Unique id of the event.
`event`	Name of the event.
`data`	Full body of the object on which the event was triggered.
`previousValues`	Contains the previous values of the object params that were updated and resulted in the event being triggered.
`createdAt`	Time of event creation.

{
   "id":"evt_9n5ev10g6ozjnn681y4azjdkl2",
   "event":"FIAT_ACCOUNT.UPDATED",
   "data":{
      "id":"fac_ov8jkx67ny1dbglamy",
      "owner":{
         "type":"END_USER",
         "id":"eus_emv4j231821oaz56yx"
      },
      "balance":{
         "actual":"0.00",
         "available":"0.00",
         "reserved":"0.00"
      },
      "currency":"GBP",
      "bankDetails":{
         "bankAddress":null,
         "bankName":"Modulr FS Ltd.",
         "accountHolderName":"Satoshi Nakamoto`",
         "country":"GB",
         "iban":null,
         "bic":null,
         "accountNumber":"70835104",
         "routingCode":{
            "value":"000000",
            "type":"SORT_CODE"
         }
      },
      "label":"Sandbox GBP Account",
      "status":"ACTIVE",
      "tags":[
         "CLIENT_MONEY"
      ],
      "createdAt":1637649088135582000,
      "updatedAt":1637649090013297000,
      "metadata":null
   },
   "previousValues":{
      "id":"fac_ov8jkx67ny1dbglamy",
      "status":"CREATED"
   },
   "createdAt":1637649090084000
}