Webhooks
Beam uses Svix to send webhooks to your application. Please check their docs on receiving webhooks to learn about how these are set up. For security, please make sure to verify the signature supplied by Svix. The methodology for this can also be found in their docs. You can configure webhooks on the sandbox and production consoles in the API tab under settings.
NOTE::
- You may receive the same webhook twice. This may happen if we need to reprocess data on our end. If this happens, you should refetch the data as it may have changed.
- For most bodies you will not receive the data in the webhook, you will have to call the corresponding endpoint.
Available Webhooks:
Schemas for the below webhooks can be found in the Svix portal available via console (see above).
The currently available webhooks are as follows:
Connect
connect.complete- user has completed the connect process. You can receive this as well as a redirect back to your application. We recommend using both in case the user completes the connect process but somehow the redirect fails to reach you (e.g. the lose internet connectivity).
Bank
bank.affordability_calculated- corresponds with the affordability endpoint.bank.expense_insights_calculated- corresponds with the expense insights endpoint.bank.income_analysis_calculated- corresponds with the income analysis endpoint.bank.liquidity_score_calculated- corresponds with the liquidity score endpoint.bank.risk_insights_calculated- corresponds with the risk insights endpoint.bank.transactions_labelled- corresponds with the transactions endpoint.bank.health_score_calculated- corresponds with the health score endpoint.