Roles

These are the roles that are needed:

  • Admin
  • Can delete webhooks
  • Can read webhooks
  • Can write webhooks

Webhooks

Webhooks are a user-defined mechanism that can call another server in response to an event. When a predefined event occurs on the website, the webhook can invoke behavior on another site in near real-time.

Creating a webhook

  1. Click on ADMIN in the top navigation.
  2. Choose Settings from the left navigation bar.
  3. Choose Webhooks from the menu that appears from under the Settings icon.
  4. On the top of the list:
    1. Give the webhook a name, and optionally a description.
    2. Add the URL which the webhook shall POST a message to.
    3. If you want headers sent you can define the header, and the value. Click + ADD.
    4. Select which Event type of objects that shall be listened to.
    5. Optionally if you want the webhook only to POST for a particular object, input the object ID.
    6. Select for which realm that the object shall be listened to.
    7. Select which operations that can happen for the object shall be listened to.
    8. Select whether the webhook is enabled on creation.
  5. Click + ADD to add the webhook.

Statuses

  • If Enabled is selected, the webhook will listen. If the POST to the URL is unsuccessful it will change the status to Failing.
  • If Failing is selected, the webhook will listen. If the POST to the URL is unsuccessful for 5 hours from the status change to Failing it will change the status to Disabled.
  • If Disabled is selected, the webhook will sleep until changing the status to Enabled.

Update a webhook

On the admin page:

  1. Choose Settings from the left navigation bar.
  2. Choose Webhooks from the menu that appears from under the Settings icon.
  3. Right click on the webhook you wish to update.
  4. Select Edit Webhook.
  5. Edit the field.
  6. Click to update the webhook.

Delete a webhook

On the Admin page:

  1. Choose Settings from the left navigation bar.
  2. Choose Webhooks from the menu that appears from under the Settings icon.
  3. Right click on the webhook you wish to delete.
  4. Select Delete Webhook.
  5. Confirm by clicking