Updating a Webhook

An existing webhook can be edited or deleted using Account Settings.

You can edit a webhook, view logs or delete the webhook entirely.

Note: This functionality is only available for Admin+ users.

  1. Select your Profile icon in the upper-right corner of the page, and then select Account Settings from the drop-down menu to open the Account Settings page.
    menu Account settings
  2. Select Webhooks from the side menu.
  3. Hover over an existing webhook and select the edit button-3 More Actions icon to view the edit options:

Edit Webhook

Webhooks can be edited at any time.

To edit an existing webhook:

  1. Select Edit from the edit button-3 More Actions icon drop-down menu. You can also select the Webhook card to open the Edit dialog.
    edit webhook dialog
  2. Edit the Webhook Name, Endpoint/URL and Event Types. See Creating a Webhook for more information on these fields.
  3. Select the Apply button to save any changes or the Cancel button to exit the dialog without saving.

View Logs

You can view logs to review and troubleshoot a specific webhook or all webhooks at once.

To view the webhook logs:

  1. Select View Logs from the edit button-3 More Actions icon drop-down menu to view a specific webhook's log or select the View Logs button from the Webhook section in Account Settings to view all webhook logs at once.
  2. The Webhooks page displays filtered by Endpoint of the selected webhook or all webhooks display non-filtered, sorted alphabetically when View Logs is selected from Account Settings.
    webhooks view logs new
    The View Logs grid includes:
    • Status: Displays the status of the webhook (Failure or Success)
    • Code: Displays the response code of the webhook (200, 404, etc.)
    • Event Type: Displays the event type of the webhook (Assignment, Project, Client, etc.)
    • Name: Displays the webhook name
    • Endpoint: Displays the endpoint of the webhook
    • Version: Displays the version number
    • Date/Time: Displays the date the webhook was logged (Newest to Oldest)
  3. Select anywhere in a log's row to view details.
    web log details
    Log details include:
    • Status
    • Webhook name
    • Endpoint
    • Event Name
    • Payload (Request Body and Response Body, i.e., JSON object)
  4. Select REQUEST BODY or RESPONSE BODY sections to view the code for that function.
    • Select the view logs copy button-1 button to copy the code.
  5. Select Replay to rerun the event or Close to exit the dialog.

Delete Webhook

You can delete a webhook at any time in a couple ways.

To delete a webhook:

  1. Select Delete from the edit button-3 More Actions icon drop-down menu on the webhook's tile on the Webhooks page or select the Delete Button 1 Delete icon at the bottom of the Edit Webhooks dialog.
  2. An "Are you sure you want to delete this webhook?" message displays.

    webhook delete
  3. Select Delete to continue or Cancel to return to the previous dialog without deleting the webhook.

See Also:

Creating a Webhook

Viewing a Public Key

Using Swagger and the Audere API