If your business relies on transfer status updates to make business decisions (releasing inventory, dispersing funds, etc.), then polling Mesh’s managed transfers endpoint is an inefficient and ineffective solution. Mesh offers webhooks to solve this problem. A webhook is a callback function that allows lightweight, event-driven communication between 2 systems. The events that trigger communications from Mesh’s webhooks are updates to transfer statuses. Instead of polling a Mesh endpoint, you can provide Mesh (via the Dashboard) with a unique callback URL which will automatically receive transfer status updates as Mesh learns about them.

Secure Data Transmission

  • Mesh uses HMAC (Hash-based Message Authentication Code)
  • When clients register their Webhook URI, they receive a Secret from Mesh which will be used in signing the request.
  • Mesh signs each webhook request using a secret key. The receiver can verify the signature using the same secret key to ensure the data has not been tampered with.
  • Mesh will include a signature header (e.g., X-Mesh-Signature-256) that the receiver can use to validate the integrity and authenticity of the payload.

This is the function we use for creating HMAC signature that is used in the request header:

 public string GenerateHmacSignature(string payload, string webhookSecret)
    {
        using var hmac = new HMACSHA256(Encoding.UTF8.GetBytes(webhookSecret));
        byte[] hash = hmac.ComputeHash(Encoding.UTF8.GetBytes(payload));
        return Convert.ToBase64String(hash);
    }

Webhook Event Models

TransferUpdateWebhookQueueItem

The TransferUpdateWebhookQueueItem model contains the core information related to a transfer update. Below are the fields available in this model:

  • EventId (Guid): A unique identifier for the event. This event identifies each message sent to clients.
  • TransferId (Guid): The unique identifier of the transfer related to this event.
  • Timestamp (long): The timestamp indicating when the event occurred.
  • TransferStatus (TransferPreviewExecutionStatus): The status of the transfer at the time of the event. This is an enumeration representing various possible states of the transfer.
  • TransactionId (string): The unique identifier for the transaction associated with the transfer.
  • UserId (string): The unique identifier of the user associated with the transfer.

TransferUpdateWebhookEvent

The TransferUpdateWebhookEvent model extends TransferUpdateWebhookQueueItem and includes additional fields specific to the event. Below are the fields available in this model:

  • Id (Guid): A unique identifier for the webhook event. This is considered as SentID, there maybe multiple retries for any event pushed into the queue. For each try for sending a specific event there is a different Id.
  • SentTimestamp (long): The timestamp indicating when the webhook event was sent.

Data Payload

JSON, the standard format for TransferUpdateWebhookEvent payloads.

{
	"EventId":"56713e70-be74-4a37-0036-08da97f5941a",
	"Id":"358c6ab7-4518-416b-9266-c680fda3a8dd",
	"SentTimestamp":1720532648,
	"Timestamp":1715175519038,
	"TransactionId":"transaction_id_provided_by_client",
	"TransferId":"dd4063e5-f317-441c-3f07-08dc7353b6f8",
	"TransferStatus":"Pending",
	"UserId":"user_id_provided_by_client"
}

Transfer Status Values

  • pending: The transfer has been initiated via Mesh, but has not yet reached a final state. Mesh does not yet have a Transfer Hash for this transfer.
  • succeeded: A final state that indicates the transfer was successfully delivered to the destination address. Mesh has a Transfer Hash for this transfer.
  • failed: A final state that indicates the transfer has failed. No transfer hash available.

Create and register your callback URI

  • Create an endpoint that can receive a POST request with application/json content.
  • Go to Account —> API Keys in your Mesh Dashboard.
  • Scroll down to “Production Transfer Webhook URI” and “Sandbox Transfer Webhook URI”

Register Webhook

  • When registering an endpoint, you’ll be prompted to store your secret key, as you won’t be able to view it again.

Register Webhook

  • You can only save one production URI and one Sandbox URI, but you can deactivate one and save a new one at any time.

Register Webhook

How to respond to a Mesh webhook event

  • Please respond with a 200 response in < 200ms to confirm receipt of the event.
  • If Mesh does not receive a 200 response in < 200ms, the webhook will retry (you will receive the event again with all duplicate information except for a different Id).