Integration checklist

To help you out during your integration process, we've created a checklist for you to follow 😉. Please make sure you address all the items before requesting access to the Production environment.

1️⃣ Implement the widget

While you're integrating the widget, make sure that:

  • Your users first register an account with your application before accessing Okra.
  • You customize your own Widget
  • You implement the Success and Close callback functions.


We strongly recommend that you follow the flow of first registering your user with your platform before implementing the widget. This way, you avoid any errors.

2️⃣ Error handling

Make sure that your integration can handle, and log the request_id of:

  • 400 and 401 errors
  • 500 Errors
  • Timeout errors

We ask you to log the request_id just in case you need to reach out to our support team. With this ID, we can speed up the troubleshooting process and figure out a solution for you.

3️⃣ Request handling

Can your integration handle:

  • 201 Success responses
  • Pagination

4️⃣ Webhooks

If your integration uses recurrent links, make sure you:

  • Set a webhook URL in the dashboard so that you can receive webhook events.
  • If it becomes needful, request a refresh rate of 6 or 12 hours
  • Make sure you only send GET requests after your receive a webhook event

Please remember that you'll need to set different URLs depending on the environment you're working in.

5️⃣ Statuses

Does your integration:

  • Monitor for invalid and token_required statuses, and if needed, prompt your users to update their credentials?

6️⃣ Non-breaking changes

If we make the following non-breaking changes to our API, are you sure it won't affect your integration?

  • New fields or a different order in the response body
  • Change the number of characters for a string
  • Add new endpoints

7️⃣ URL and API Keys

When you are switching to Production, make sure that:

  • You are calling the production version of the Okra API
  • You are using your Okra Production API Keys
  • You are storing your API keys securely.

Now that you're done with the steps for getting started, check out our environments.