This guide will take you through how to use the Developer tools, which includes setting up API keys and webhooks. If you're looking for guidance on how to log in, click here.


Jump to:

What are API keys and webhooks?

The Developer tools section provides access to API keys and webhooks, which allow secure communication between Lightning Reach and external systems.

  • API keys are unique identifiers used to authenticate requests made to the Lightning Reach API. They must be included as a Bearer token in the Authorisation header of every API request.
  • Webhooks enable real-time notifications when specific events occur. 


Accessing Developer tools

The Developer tools section in Lightning Reach allows you to manage API keys and webhooks, enabling integrations with your internal systems. 

To access Developer tools, you must:

For more details on user roles and how to assign them, refer to our roles overview guide.


Once you are logged in, to access this area, click Developer tools from the left-hand menu. 


 



Environment-specific URLs

Your API requests should be directed to the appropriate environment:

Demo environment (useful for testing)

Production environment

How to create an API key

Step 1: Navigate to the Developer tools section. 


Step 2: Click Create new API key.


Step 3: Important - Once generated, copy and store the key immediately, you won’t be able to view it again after navigating away from this screen. 


Additional notes on API keys: 

  • Lightning Reach's API keys are have a Authorization: Bearer [API-KEY] header.
  • Test your API key in the demo environment first to ensure it's working correctly before using it in production.

How to generate a webhook

Step 1: Navigate to the Developer tools section. 


Step 2: Click Create webhook.


Step 3:

 



In the pop-up window, enter:

  • ✦ A memorable name for your webhook.
  • ✦ The webhook URL (this must be an HTTPS URL where you want to receive events).
  • ✦ Select the events you want to subscribe to.

Click Submit to save the webhook.









Step 4: Once created, your webhook will appear in the list of active webhooks.


You can click View to see webhook details, test the webhook, or delete it if needed. Example below:



Additional notes on webhooks:

  • Webhooks contain only the event key and the corresponding resourceId. For any additional data, this can be fetched from the API using the resourceId.

What's next?

Click on the below links to view the following articles:


Need further assistance?

If you have any questions or encounter any difficulties, please don't hesitate to contact us at [email protected]