Developer Settings

Developer Settings

Show Me
Creating and managing webhooks

The developer settings page lets you configure webhooks and set up access for API keys.

Webhooks

Webhooks allow you to automatically send notifications back to a waiting application. ExaVault will POST a message to a URL when certain triggering events occur. The application can then take that information and do further automatic processing internally or by connecting to ExaVault through our API.

For example, you could set up a webhook to notify your application whenever a file is uploaded to ExaVault. When the file is uploaded, the webhook triggers and sends a special message back to your app with some details about the uploaded file. Your application then uses the API to log in to ExaVault and download the file. The downloaded file can now be used in other automatic processes in your business such as importing into an order system.

Your webhooks settings can be edited on the developer page:

  1. Click on the My Account button in the main toolbar.
  2. Click on the DEVELOPER tab.
  3. Enter the endpoint URL that will receive the JSON object messages from ExaVault.
  4. Check on the triggering event(s) that will cause ExaVault to send a JSON object message to the endpoint URL.
  5. Click the SAVE CHANGES button at the bottom of the page to save your changes.

For more detail on using webhooks, please see our developer documentation.

API Keys

Show Me
Creating and managing API Keys

The API lets you control nearly all aspects of your ExaVault account programatically, from uploading and downloading files to creating and managing shares and notifications. In order to use the API, you'll need to obtain an API key and use it to authenticate to your ExaVault account.

Manage API keys

Show Me
Creating and managing API Keys

You will need to obtain an API key to connect to the API.

To create and manage API keys for your ExaVault account:

  1. Click on the My Account button in the main toolbar.
  2. Click on the DEVELOPER tab.
  3. In the Development resources click the Manage API Keys link.

Adding a new API key

Show Me
Creating an API Key

In the section Add API Key, two fields will be needed to create the key.

  1. Fill in the Application name.
  2. Enter a short description of your application.
  3. Click the ADD API KEY button.
  4. The new API key value is listed under the Key column and is ready to use in your API code.

Show Me
Saving an API Key value

Saving the API key value

After you have created the API key, copy/paste the key value ExaVault provides and include that key value in your API code.

Editing and deleting existing API Keys

Show Me
Editing an API Key

  1. Click on the My Account icon in the main toolbar.
  2. Click on the DEVELOPER tab.
  3. In the Development resources section click the Manage API Keys link.
  4. Click the Edit link if you need to make changes on an existing API key.
  5. Click the UPDATE API KEY button to save changes.
  6. To delete the API key, click Delete and confirm the deletion by clicking the Yes key.

Show Me
Deleting an API Key

*NOTE: You must have admin or master permissions to create an API key for your account. If you do not have access to developer settings for your account, contact your account administrator to create an API key for you.

Did you find an issue with this article? Let us know!

account/09-settings/06-developer-settings.txt · Last modified 2019/07/11 11:50 (external edit)