Set-up
| Note |
|---|
The Webhook functionality can only be configured via Arken Public API. |
To enable webhooks, you need to have the following:
- An active Arken Account, mainly your Arken Account Hash Identifier
- Your Arken API Access Key and Secret Key
- Your API endpoint that will be receiving the callback from Arken
- Your API endpoint security details - This should be a secret header key or Open ID Connect Access and Secret Keys
To enable the webhook subscription, you need to call the HTTP POST /Event/Subscription endpoint providing the following details:
- Your Arken Account Hash Identifier
- The HTTP POST Url where Arken needs to send the events to
- The Callback API Version number (if available)
- The security details needed for Arken to execute a post, i.e. Secret Header value or Open ID Connect Access and Secret Keys
Events
Event Categories
When configuring a webhook, you will be sent the following events:
| Event Category | Event Type | Description |
|---|---|---|
| Account | Update | Updates were conducted on your current account |
| Client | Create | A new client has been created |
| Update | An existing client has been updated | |
| Delete | An existing client has been deleted | |
| DocumentData | Create | A new document data entry has been created |
| Update | An existing document data has been updated | |
| Delete | An existing document data has been deleted | |
| User | Create | A new Arken user is added under your current Account |
| Update | An existing Arken user is updated | |
| Delete | An existing Arken user is deleted | |
| FileStore | GetFileDetailDownload | An existing document has been fetched for download |
| Upload | A document has been created and is ready to be downloaded |
Delivery attempts and retries
The Arken service will attempt to deliver your webhooks in near-real time. If the webhook sendout encounters an issue, the Arken system will try to attempt sending the event 3 times prior to abandoning the sendout. Arken Webhooks cannot be manually retried after this time, though you can query for the event using the Event endpoints to reconcile your data with any missed events. For more information on accessing the Event endpoints, please see the /wiki/spaces/MAIN/pages/100433931 page.
Sample Webhook Client Code
Attached below is a sample code on receiving Webhooks on your system.
| View file | ||||
|---|---|---|---|---|
|
The sample attached contains a .NET core application that has one post endpoint that will receive the event.