​
Webhook Events

Carbon provides webhook events to notify you about specific actions in your account. Below are the details of the supported events:

​
account.incoming-transaction

This event is triggered when an incoming transaction is received in your account.

​
Payload Example

{
    "event": "account.incoming-transaction",
    "data": {
        "id": "string",
        "amount": "float",
        "currency": "string"
        "transactionType": "string",
        "entryDate": "datetime",
        "uniqueRef": "string",
        "account": {
            "id": "string",
            "bankAccount": {
                "accountName": "string",
                "accountNumber": "string",
                "bank": {
                    "code": "string",
                    "name": "string"
                }
            },
            "static": boolean,
            "currency": "string",
            "clientId": "string"
        }
    }
}

​
account.outgoing-transaction

This event is triggered when an outgoing transaction is made from your account.

​
Payload Example

{
    "event": "account.outgoing-transaction",
    "data": {
        "id": "string",
        "amount": "float",
        "currency": "string"
        "transactionType": "string",
        "entryDate": "datetime",
        "uniqueRef": "string",
        "account": {
            "id": "string",
            "bankAccount": {
                "accountName": "string",
                "accountNumber": "string",
                "bank": {
                    "code": "string",
                    "name": "string"
                }
            },
            "static": boolean,
            "currency": "string",
            "clientId": "string"
        }
    }
}

For more information on setting up and managing webhooks, refer to the Webhooks Introduction documentation.

​
Webhook Events

Carbon provides webhook events to notify you about specific actions in your account. Below are the details of the supported events:

​
account.incoming-transaction

This event is triggered when an incoming transaction is received in your account.

​
Payload Example

{
    "event": "account.incoming-transaction",
    "data": {
        "id": "string",
        "amount": "float",
        "currency": "string"
        "transactionType": "string",
        "entryDate": "datetime",
        "uniqueRef": "string",
        "account": {
            "id": "string",
            "bankAccount": {
                "accountName": "string",
                "accountNumber": "string",
                "bank": {
                    "code": "string",
                    "name": "string"
                }
            },
            "static": boolean,
            "currency": "string",
            "clientId": "string"
        }
    }
}

​
account.outgoing-transaction

This event is triggered when an outgoing transaction is made from your account.

​
Payload Example

{
    "event": "account.outgoing-transaction",
    "data": {
        "id": "string",
        "amount": "float",
        "currency": "string"
        "transactionType": "string",
        "entryDate": "datetime",
        "uniqueRef": "string",
        "account": {
            "id": "string",
            "bankAccount": {
                "accountName": "string",
                "accountNumber": "string",
                "bank": {
                    "code": "string",
                    "name": "string"
                }
            },
            "static": boolean,
            "currency": "string",
            "clientId": "string"
        }
    }
}

For more information on setting up and managing webhooks, refer to the Webhooks Introduction documentation.