In the Open API Keys section, you can obtain API keys that will facilitate the integration of third-party services with the CRM. These API keys serve as authentication credentials, allowing authorized access to the CRM's functionality and data.
Additionally, within the Open API Keys section, you can also view the host information. The host refers to the server or network location where the CRM is hosted. This information is helpful for configuring the integration settings correctly and ensuring a seamless connection between the CRM and the integrated third-party services.
To retrieve the Open API Key, follow these steps:
Click on the "Create API Key" button.
Enter a name for the API Key to easily identify its purpose or usage and click "Save".
The API Key will be generated and displayed on the screen. It is recommended to copy the API Key by clicking the "Copy" button.
Make sure to store the API Key in a secure location, such as a password manager or a secure document.
Please note that once you close the tab or navigate away from the page, you will not be able to retrieve the API Key again.
To delete Open API keys, follow these steps:
Locate the Open API key that you want to delete.
Click on the "Delete" icon associated with the API key.
A popup message will appear, informing you that the API key will be permanently deleted and cannot be retrieved.
In the "Dev Space" section, it encompasses the settings configuration specifically tailored for development or integration purposes. This section provides essential tools and resources to facilitate smooth integration and development processes. These include:
Webhooks
Open API Keys
Security Credentials
To initiate your usage of webhooks, simply click on "Learn More" to access the API documentation dedicated to webhooks.
Upon clicking, you'll be directed to a new tab containing the API documentation.
Click "Create Webhook".
Fill in the respective fields:
Name - this refers to the name of the webhook.
Destination URL - this is the URL where the information will be received.
Select Function - currently, webhooks only support withdrawals, prop trading participation and prop trading live stage requests.
Select Event - this determines when information is transmitted via the webhook to the destination URL.
Approve Withdrawal - Node N
N corresponds to the approver level.
If you select both Node 1 and 2, it means that if the level 1 or 2 approver approves the withdrawal request, information will be sent through the webhook. This configuration should be aligned with your withdrawal process.
Reject Withdrawal: Information will be sent to the destination URL when withdrawal requests are rejected.
Secret Key
Click "Save" to successfully create the new webhook.
To edit a webhook, follow these steps:
Locate the desired webhook and click the "Edit" icon.
Make the necessary changes.
Confirm your changes by clicking "Save".
To access webhook logs, simply click on the "History" icon.
You will be able to view the details of each log.
You can review the details of the webhook request by simply clicking on it.
Should you wish to re-send a specific request, click on the "Resend" icon.
A confirmation popup will appear before proceeding with the action.
To disable webhooks, follow these steps:
Find the specific webhook you wish to disable and select the "Disable" icon.
Once a webhook is disabled, it will cease to transmit messages to the designated destination URL.
To reactivate the webhook, simply click on the same icon.
To delete a webhook, follow these steps:
Find the desired webhook and click the "Delete" icon.
A popup confirmation message will appear for your verification.
Click "Confirm" to proceed with the deletion.
When clients submit a withdrawal request, and upon the occurrence of the first triggered event (as configured for the webhook), the data will be sent to the designated destination URL.
The transmitted information will encompass the data boxed up in yellow in the provided image.
After the withdrawal process is completed in the third-party system, you can proceed with the subsequent review steps for the submitted request.
Confirm your decision by clicking on the "Confirm" button to proceed with the deletion.
In the Security Credentials section, you can access and manage the token used for authentication in the CRM open integration interface. The token serves as a means of verifying and securing the integration process.
Here are the key features and actions related to security credentials:
View Token: You can view the current token that is being used for authentication.
Refresh Token: If needed, you can refresh the token to generate a new one. This action is useful for security purposes or when a token has expired or needs to be updated.
Token Refresh Timestamp: The security credentials page also displays the timestamp of when the token was last refreshed. This information helps you track the token's usage and monitor its validity.
