Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

What outgoing webhooks means?

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

Info

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 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

Expand
titleExample of request body
Code Block
languagejson
{
    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 Administration and then to Outgoing webhooks

...

2.

3.

...

Panel
panelIconId1f308
panelIcon:rainbow:
panelIconText🌈
bgColor#E6FCFF

Image of menu

2. Click on Create webhook

Panel
panelIconId1f308
panelIcon:rainbow:
panelIconText🌈
bgColor#E6FCFF

Image of the button to create

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

Info

Only supports secure requests under https protocol

Panel
panelIconId1f308
panelIcon:rainbow:
panelIconText🌈
bgColor#E6FCFF

Image of create page

 4. Save

 

Check the outgoing webhook status

...