Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

What outgoing webhooks means?

Outgoing Webhooks are Projectrak's way of communicating with external systems when something happens in the application.

Currently, the only supported event we have is the update of project field values.

How it works

Whenever the value of one or multiple fields is changed in a project, a notification with the change data will be sent to the configured external system.

The webhooks react to changes made in system project fields and custom fields added by Projectrak, excluding calculated fields of Formula type.

The external system must have an URL that accepts POST requests.

Projectrak will make a POST request to the URL configured by Jira's administrator with the following data:

  • The type of event that triggered the notification

  • The user who made the change in the fields

  • The moment when the change was made

  • The project that has been updated

  • The list of fields that have been changed along with the modification in each one

Example of request body

{
    data: {
        event: "updated",
        user: "DUMMY-ACCOUNT-ID-4c44-b436-73155f48d985",
        timestamp: 1675182117615,
        project: {
            id: 13647,
            key: "DEMO",
            name: "Demo project"
        },
        fields: [
            {
                id: 12345,
                name: "Budget",
                type: "number",
                value: {
                    current: "23.000",
                    previous: "25.000"
                }
            },
            {
                id: 54321,
                name: "Status",
                type: "status",
                value: {
                    current: "Done",
                    previous: "On track"
                }
            }
        ]
    }
}

Configure an outgoing webhooks

1. Go to Projectrak Administration and then to Outgoing webhooks

2. Click on Create webhook

3. Provide a name to identify the webhook and specify the URL where you want the requests to be made.

Only supports secure requests under https:// protocol

 4. Save the webhook

Check the outgoing webhook status

In the webhook administration section, you will be able to see all the created webhooks, their last execution, and their latest returned status.

Two types of statuses will be displayed:

  • OK for all status codes in the 2xx range.

  • ERROR for the rest of the status codes.

Field value formats

Fields that do not have a value will be represented as null in single values or an empty array in the fields with multiple selection.

All field values are strings except the null object. The list below indicates the information that will be send in each field type:

  • Text: The text.

  • Text multiple line: The text with the markup.

  • Number: The number.

  • Date: The date in format yyyy-mm-dd.

  • Duration: The duration in milliseconds.

  • Priority: The name of the priority.

  • Status: The name of the status.

  • List: The option name.

  • List multiple selection: A list of option names.

  • User: The user account id

  • User multiple selection: A list of user account ids.

  • Project: The project id

  • Project multiple selection: A list of project ids.

  • No labels