Webhooks

A webhook is a standard for sending messages from an app 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 screen

Webhooks screen

Video: Manage Your Organization

Examples

Prerequisites

How to Start

  1. Click Manage.

    Click Manage
  2. In Manage Center, click System > Webhooks.

    Click Webhooks

Fields

Field NameDefinition

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

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

Edit Webhook
Opens this Screen:
Edit Webhook screen
Function of this Screen:
Changes a webhook
To Open this Field:
  1. Select a Webhook.

Delete Webhook
Function:
Deletes the specified webhook.
To Open this Field:
  1. Select a Webhook.

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

Manage Common Headers
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
Description:
Shows the name of the webhooks you created.
Allowed Values:
Read only.

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

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