Newline’s Webhooks system delivers real-time event notifications grouped into topics . Each topic represents a category of related events, such as transfers, transactions, or account updates. Clients can subscribe to these topics to receive messages relevant to their business workflows.
Here are the currently supported Webhooks topics, along with definitions:
Events related to money movement between accounts.
Transfer Initiated : A transfer has been created.
Transfer Status Changed : The status of a transfer has been updated.
RTP Settlement : An instant payment transfer has settled.
Events related to financial transactions.
Transaction Created : A transaction record has been generated.
Transaction Status Updated : The transaction status has changed.
Events related to virtual accounts used for managing funds.
Account Created : A synthetic account has been created.
Status Changed : The account status has changed.
Name Updated : The account name has been updated.
Events related to instant payment identifiers.
VRN Created : A new VRN has been issued.
Instant Payment Rail Registration Status Changed : The registration status has changed.
Subscribe only to topics relevant to your workflows.
Confirm topic names with your Newline Specialist during onboarding.
Implement idempotency using event IDs.
Validate HMAC signatures for each event.
Category Event Name Trigger Topic Name Transfer Transfer Initiated A transfer has been initiated. <client>.<env>.transfer
Payload
{
"event_type": "created",
"details": {
"customer_external_uid": "A5B4C6F9h51j2j3j",
"customer_uid": "ab12cd34ef56gh78",
"transfer_uid": "Zb12cd34ef56gh7X",
"transaction_uid": "nYesn8dcge49Dqgm",
"transaction_uids": [
"nYesn8dcge49Dqgm"
],
"usd_transfer_amount": "321.00",
"destination_customer_external_uid": "A5B4C6F9h51j2j3j",
"destination_customer_uid": "ab12cd34ef56gh78"
}
}
Category Event Name Trigger Topic Name Transfer Transfer Status Changed The status of a transfer has been updated. <client>.<env>.transfer
Payload
{
"event_type": "status_change",
"details": {
"customer_external_uid": "rb12cd34ef56ghd4",
"customer_uid": "Zb12cd34ef56gh7X",
"new_status": "settled",
"old_status": "pending",
"transfer_uid": "fb12cd34ef563gq2",
"transaction_uid": "s8J7J6J5J5h31A28",
"transaction_uids": [
"s8J7J6J5J5h31A28"
],
"destination_customer_external_uid": "rb12cd34ef56ghd4",
"destination_customer_uid": "Zb12cd34ef56gh7X"
}
}
Category Event Name Trigger Topic Name Transfer RTP Settlement An instant_payment
Transfer has reached settlement. Please note this is a separate event than a Transfer or Transaction's status update events. <client>.<env>.transfer
Payload
{
"event_type": "rtp_settlement",
"details": {
"customer_external_uid": "business-partner-unique-identifier-8",
"customer_uid": "gXjG87TQEUmsdVSg",
"transfer_uid": "fb12cd34ef563gq2",
"transaction_uid": "exJmgX7ABWX4DFU4",
"transaction_uids": [
"exJmgX7ABWX4DFU4"
],
"destination_synthetic_account_uid": "phBEeJ4CN8EVuBAU",
"destination_customer_external_uid": "rb12cd34ef56ghd4",
"destination_customer_uid": "Zb12cd34ef56gh7X"
}
}
📘 Please note that account balances update when a Transfer's status updates. The above event notes settlement, which occurs immediately prior to the status being updated. If interested in being updated of account balance update, subscribe to the status change events.
Category Event Name Trigger Topic Name Transaction Transaction Created A transaction record has been created. <client>.<env>.transaction
Payload
{
"event_type": "created",
"details": {
"asset_breakdown": [
{
"asset_quantity": "-5.0",
"asset_type": "USD",
"synthetic_account_uid": "y3mgbw9CdzMWa2m7",
"us_dollar_amount": "-5.00"
}
],
"customer_external_uid": "business-partner-unique-identifier-27",
"customer_uid": "zK7DSmQiqFVue624",
"debit_card_uid": "gdgN9zmH6PTfzgUe",
"denial_reason": "insufficient_funds",
"description": "description",
"destination_synthetic_account_uid": "hpqbJpevVzafUc1T",
"net_asset": "negative",
"new_status": "denied",
"settled_index": null,
"source_synthetic_account_uid": "y3mgbw9CdzMWa2m7",
"transfer_uid": "fb12cd34ef563gq2",
"transaction_uid": "c2c7Kws8cR8ZCBLn",
"type": "atm_withdrawal",
"us_dollar_amount": "5.00",
"ach_return_code": null
}
}
Category Event Name Trigger Topic Name Transaction Transaction Status Updated The status of a transaction has been updated. <client>.<env>.transaction
Payload
{
"event_type": "updated",
"details": {
"asset_breakdown":[
{
"asset_quantity": "-5.0",
"asset_type": "USD",
"synthetic_account_uid": "zoPodA7UtHKm9APD",
"us_dollar_amount": "-5.00"
},
{
"asset_quantity": "0.25",
"asset_type": "LPL",
"synthetic_account_uid": "phBEeJ4CN8EVuBAU",
"us_dollar_amount": "5.00"
}
],
"customer_external_uid": "business-partner-unique-identifier-8",
"customer_uid": "gXjG87TQEUmsdVSg",
"debit_card_uid": "QeaBfr63HSb3pReT",
"denial_reason": null,
"description": "description",
"destination_synthetic_account_uid": "phBEeJ4CN8EVuBAU",
"net_asset":"neutral",
"new_status": "pending",
"settled_index": null,
"source_synthetic_account_uid": "zoPodA7UtHKm9APD",
"transfer_uid": "fb12cd34ef563gq2",
"transaction_uid": "exJmgX7ABWX4DFU4",
"type": "atm_withdrawal",
"us_dollar_amount": "5.00",
"ach_return_code": null
}
}
Category Event Name Trigger Topic Name Synthetic Account Synthetic Account Created A synthetic account record has been created. <client>.<env>.synthetic_account
Payload
{
"event_type": "created",
"details": {
"external_uid": "client-generated-id",
"customer_uid": "mRJMrhj97MlfPLkdgk",
"status": "active",
"synthetic_account_category": "general",
"synthetic_account_uid": "6NrMNrdB4hVHDXbx",
"pool_owner_customer_uid": "mRJMrhj97MlfPLkdgk",
"pool_uid": "i4wGvRybCiqg3Zhc",
"routing_number": "123456789"
}
}
Category Event Name Trigger Topic Name Synthetic Account Synthetic Account Status Changed The status of a synthetic account has been updated. <client>.<env>.synthetic_account
Payload
{
"event_type": "status_change",
"details": {
"additional_info": {
"message": "error message; additional_info could be null",
},
"external_uid": "client-generated-id",
"customer_uid": "pLJM7hjs7MqfDknvh",
"new_status": "failed",
"old_status": "initiated",
"synthetic_account_category": "wire_external",
"synthetic_account_uid": "6NrMNrdB4hVHDXbx"
}
}
Category Event Name Trigger Topic Name Synthetic Account Synthetic Account Name Updated The name of a Synthetic Account has been updated. <client>.<env>.synthetic_account
JSON
{
"event_type": "name_updated",
"details": {
"additional_info": nil,
"external_uid": "client-generated-id",
"customer_uid": "pLJM7hjs7MqfDknvh",
"new_status": "active",
"old_status": "active",
"synthetic_account_category": "wire_external",
"synthetic_account_uid": "6NrMNrdB4hVHDXbx"
}
}
Category Event Name Trigger Topic Name VRNs VRN Instant Payment Rail registration status change The status of a VRN's Instant Payment Rail registration has been updated. <client>.<env>.virtual_reference_number
Payload
{
"event_type": "created",
"details": {
"external_uid": "client-generated-id",
"virtual_reference_number_uid": "mRJMrhj97MlfPLkdgk",
"status": "active",
"instant_payment_rail_registration_status": "pending",
"synthetic_account_uid": "6NrMNrdB4hVHDXbx",
"virtual_reference_number_last_four": "5624",
"routing_number": "123456789"
}
}
Category Event Name Trigger Topic Name VRNs VRN Instant Payment Rail registration status change The status of a VRN's Instant Payment Rail registration has been updated. <client>.<env>.virtual_reference_number
Payload
{
"event_type": "instant_payment_status_change",
"details": {
"external_uid": "client-generated-id",
"virtual_reference_number_uid": "mRJMrhj97MlfPLkdgk",
"status": "active",
"new_instant_payment_rail_registration_status": "archived",
"old_instant_payment_rail_registration_status": "unregistered"
}
}
Category Event Name Trigger Topic Name Customer Customer Status Changed Sent any time a customer's status is updated <client>.<env>.customer
JSON
{
"event_type": "status_change",
"details": {
"customer_uid": "A1B2C3D48I7H6G5F",
"external_uid": "h5B7h11M89Yt6R54",
"new_status": "approved",
"prior_status": "manual_review"
}
}
Category Event Name Trigger Topic Name Customer Customer Locked A customer is locked <client>.<env>.customer
JSON
{
"event_type": "lock",
"details": {
"customer_uid": "A1B2C3D48I7H6G5F",
"external_uid": "h5B7h11M89Yt6R54"
}
}
Category Event Name Trigger Topic Name Customer Customer Unlocked A customer is unlocked <client>.<env>.customer
JSON
{
"event_type": "unlock",
"details": {
"customer_uid": "A1B2C3D48I7H6G5F",
"external_uid": "h5B7h11M89Yt6R54"
}
}