Webhooks
1. Webhook API Documentation
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.
2. Creating Webhooks
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.
3. Editing Webhooks
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".
4. View History
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.
5. Disable Webhooks
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.
6. Delete Webhooks
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.
7. Reviewing Withdrawal Requests
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.
Last updated