Go-live Checklist

This Go-live Checklist is a guideline of best practices to consider before you launch your integration with Beam to production.

This checklist is intended for solutions that directly integrated with Beam API. This is not applicable if you use Beam through a connected website or plug-in.

Set up API Keys

Make sure you set up API Keys in the correct environment. Note that your Playground API Keys are NOT usable in Production.

If you are a merchant, please make sure to set up Merchant API Key in Lighthouse under the Developers section.
If you are a partner, please make sure to set up Partner API Key in Bridge under the Merchants > API Keys section. Also, please make sure you provide your Beam Partner ID in the header X-Beam-Partner-ID.

Please refer to Authentication for more details.

Review error handling

Make sure you handle every possible errors, including those unlikely errors, including but not limited to:

REQUEST_CONFLICT_ERROR
TOO_MANY_REQUESTS_ERROR
HTTP Status 5xx

Also, be mindful of the information you provide to a user. An invalid input from user (i.e. API_VALIDATION_ERROR) is not the same as an invalid JSON request (i.e. INVALID_JSON_ERROR).

Review your logging

We recommend that you have sufficient logging which includes important data that could help with auditing and troubleshooting. Some examples are the endpoint and request ID.

Please make sure that any sensitive data is NOT included in your logs, such as card details or personally identifiable information.

Set up your production webhooks

If you are using webhooks, make sure that you set up webhooks in Production environment. Note that your Playground webhooks are NOT usable in Production.

Also, make sure that your webhooks:

Perform webhook authentication correctly
Do not assume that the notifications you receive are in a specific order
Does not take too long to process. If a webhook needs to perform a long-running process, for example, updating order status when receiving charge.succeeded webhook, we recommend doing it asynchronously.