Guides

Overview

Learn how to listen to events whenever certain actions occur on your account.

Suggest Edits

Webhooks are like digital messengers that notify you about specific events. Think of them as important notifications. They allow Bitpowr to notify you about events on your account, such as incoming or failed transactions.

For us, webhooks are a way to communicate with your applications in real-time, providing you with instant updates about important events that occur on your Bitpowr account.

Why Use Bitpowr Webhooks?

Aside from getting real-time updates about your account, our webhooks are easy to use and integrate with your applications.

Below are some reasons why you should integrate our webhooks into your applications:

  • Quick response to events: With our webhooks' ease, you can respond to events in no time, ensuring that your applications are always up-to-date.

  • Easy access to webhook logs: You can easily view and manage your webhook logs from your Bitpowr Dashboard, making tracking and troubleshooting issues easy.

  • Enhanced security: Webhooks are sent over HTTPS, ensuring your data is secure and protected.

  • Multiple environments: You can use webhooks in our test and live environments, allowing you to test your applications without using real digital assets.

📘

Examples of how you can use webhooks with Bitpowr:

  • Send an email notification when a new transaction is received.
  • Update your user interface to reflect the current balance of your account.
  • Log all transactions to a database for historical analysis.
  • Trigger a workflow in another application, such as a CRM system or accounting software.

How Bitpowr Webhooks Work

When an event such as a new transaction occurs on your account, Bitpowr sends a webhook notification to the URL that you specify in your webhook settings. This notification contains a JSON payload, which is a package of information that tells you all about the event.

You can then use this information to do whatever you want. For instance, you could update your user interface to reflect the new transaction, send an email notification to your users, or log the event for future reference.

Webhook Versions

We offer two versions of webhooks, version 1 and 2.

Version 1 webhooks are our older set of webhooks and will be deprecated by the end of 2024.

We recommend using version 2 webhooks for all new integrations, as they come with an improved data structure and event type.

Below is a list of event types for both versions of our webhooks:

Version 1Version 2
transaction.incomingaccounts.created
transaction.newaccounts.updated
transaction.successaccounts.archived
transaction.pendingaccounts.frozen
transaction.failedaccounts.policy.updated
transaction.pending_approvalassets.created
transaction.awaiting_confirmationaddress.created
transaction.queueaddress.updated
transaction.processingaddress.flagged
address.blocked
customer.created
customer.updated
customer.deleted
customer.attached_to_address
transaction.deposit.created
transaction.deposit.success
transaction.deposit.pending
transaction.deposit.awaiting_confirmation
transaction.deposit.aml_flagged
transaction.transfer.created
transaction.transfer.success
transaction.transfer.awaiting_confirmation
transaction.transfer.failed
transaction.transfer.cancelled
transaction.transfer.rejected
transaction.transfer.dropped
transaction.transfer.approved
transaction.transfer.approved_by_counterparty
transaction.transfer.rejected_by_counterparty
transaction.compliance.aml_flag
transaction.contract.deployment.failed
transaction.contract.deployment.success
transaction.contract.interaction.success
transaction.contract.interaction.failed

The following is a list of events we can send to your webhook URL.

📘

Helpful Tip

We advise using a webhook instead of a callback to deliver value to your clients.

Callbacks can fail if a customer's device's network connection fails or is weak, or if the device turns off after a request, among other things that are beyond our and your control.

Updated 10 months ago