Webhooks

A webhook is a standard for sending messages from an application when an event occurs. AgilePoint NX uses webhooks to send notifications based on events that occur within an NX app or in AgilePoint Server.

Figure: Webhooks Home screen

Webhooks Home screen

Examples

Prerequisites

How to Start

  1. In the Manage Center, click System System icon > Webhooks.

Fields

Field Name Definition

Create a Webhook Add Member icon
Opens this Screen:
Add Webhook screen
Function of this Screen:
Creates a webhook to send a notification when an event occurs.

Manage Secret Key Manage Secret Key icon
Opens this Screen:
Manage Secret Key screen
Function of this Screen:
Configures secret keys to authenticate webhook notifications.

Manage Common Headers Manage Common Headers icon
Opens this Screen:
Manage Common Headers screen
Function of this Screen:
Configures the custom headers to add in all webhook notifications as a name/value pair.

Name
Function:
Shows the name of the webhooks you created.
Accepted Values:
Read only.

Notification URL
Function:
Shows the endpoint service URL where you get a webhook notification when an event occurs.
Accepted Values:
Read only.

Status
Function:
Specifies whether to activate the webhook to send a notification when an event occurs.
Accepted Values:
  • On - The webhook is active and sends notifications.
  • Off - The webhook is not active and does not send notifications.
Default Value:
On

Actions
Function:
Specifies whether to change the webhook information you created.
Accepted Values:
  • Edit Webhook Edit Webhook icon - Lets you change the webhook information.
  • Delete Webhook Delete Webhook icon - Deletes the webhook.
Default Value:
None

Search Search icon
Function:
Does a search of your webhooks based on the information you specify.