Webhook

A service offered by Pier Cloud that allows our FinOps platform to integrate with a Webhook service for sending notifications via an endpoint. Whenever desired, messages can be sent through the registered endpoint, according to the service connected to it.

This document describes the steps required to configure and manage this integration, ensuring that your teams efficiently receive notifications and have access to the information they need.

Connecting the Webhook Service to the Pier Cloud Platform

Step 1: Accessing Settings

  1. Click on the user profile, then select Settings, as illustrated below:

  1. The system will display a side menu with several configuration options. Select Notifications.

  1. By clicking the "" icon, the system allows you to view the registered provider groups and add new ones.

  1. The system will then display a screen requesting the following information:

    • Select type: Webhook

    • Name: Enter a name to identify the provider

Step 2: Configuring via GET or POST Request

Settings: For the Webhook provider type, the following additional fields must be completed:

  • Server URL: The endpoint of the service that will receive the notifications.

  • Request Method: Select one of the available options:

  • Option 1: GET

When selecting the GET method, the notification information (title and content) will be sent as query parameters in the URL. In this case, the receiving server must extract these values from the URL and use them as needed.

Example:

curl --request GET \
--url 'https://example.com/webhook?title=New%20system%20alert&content=The%20process%20was%20successfully%20completed%20at%2014%3A35'

In this example:

https://example.com/webhook?title=YOUR_TITLE&content=YOUR_CONTENT

The receiving server must be prepared to read GET parameters (e.g., req.query.title / req.query.content in Node.js).

  • Option 2: POST

When selecting the POST method, the notification information (title and content) will be sent in the body of a basic HTTP request. In this case, the receiving server must extract these values from the request body.

Example:

curl --request POST \
--url 'https://example.com/webhook' \
--header 'Content-Type: application/json' \
--data '{
  "title": "New system alert",
  "content": "The process was successfully completed at 14:35."
}'

Request Headers

Enter the information to be sent:

  • Enter key: Provide the header key.

  • Enter value: Insert the value for the key and click Add.

Step 3: Saving the Configuration

Finally, click Save. The system will store the configuration, and the Webhook provider will be available within the notification group.

PreviousMicrosoft TeamsNextIntroduction

Last updated