EDB Postgres Enterprise Manager REST APIs v11.0: Webhook v10.2

get__webhook_

Code samples

GET /webhook/

Retrieve the webhook list.

Parameters

NameInTypeRequiredDescription
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

200 Response
[
  {
    "id": 0,
    "name": "string",
    "url": "string",
    "enabled": true,
    "method": "POST",
    "http_headers": [
      {
        "http_header_id": 0,
        "http_header_key": "string",
        "http_header_value": "string"
      }
    ],
    "payload_template": "{'text': 'You have new alert from PEM', 'attachments': [{'text': 'AlertID \n%AlertID% \nAlertName \n%AlertName%''}]}",
    "low_alert": true,
    "med_alert": true,
    "high_alert": true,
    "cleared_alert": true
  }
]

Responses

StatusMeaningDescriptionSchema
200OKStatus 200Inline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[Webhook]falsenonenone
» idintegerfalsenoneWebhook ID
» namestringfalsenoneWebhook name
» urlstringfalsenoneWebhook URL
» enabledbooleanfalsenoneDetermines whether the webhook is enabled.
» methodstringfalsenoneRequest method
» http_headers[WebhookGetHTTPHeaders]falsenoneList of the HTTP header key/value pairs to be used by the webhook
»» http_header_idintegerfalsenoneID of the HTTP header
»» http_header_keystringfalsenoneName of the HTTP header key
»» http_header_valuestringfalsenoneName of the HTTP header key
» payload_templatestringfalsenonePayload template. Below is payload example for slack.
» low_alertbooleanfalsenoneDetermines whether the low alert is enabled.
» med_alertbooleanfalsenoneDetermines whether the medium alert is enabled.
» high_alertbooleanfalsenoneDetermines whether the high alert is enabled.
» cleared_alertbooleanfalsenoneDetermines whether the cleared alert is enabled.
Enumerated Values
PropertyValue
methodPOST
methodPUT
Info

This operation does not require authentication

post__webhook_

Code samples

POST /webhook/

Add a new webhook.

Body parameter

{
  "name": "string",
  "url": "string",
  "enabled": true,
  "method": "POST",
  "http_headers": [
    {
      "http_header_key": "string",
      "http_header_value": "string"
    }
  ],
  "payload_template": "{ 'Alert Name':'%AlertName%'','type':'Webhook' }",
  "low_alert": true,
  "med_alert": true,
  "high_alert": true,
  "cleared_alert": true
}

Parameters

NameInTypeRequiredDescription
X-Auth-TokenheaderstringtrueToken of authorization
bodybodyWebhookPostDatatruenone

Example responses

Responses

StatusMeaningDescriptionSchema
200OKWebhook created successfully.None

Response Schema

Info

This operation does not require authentication

get__webhook_{webhook_id}

Code samples

GET /webhook/{webhook_id}

Retrieve information for the webhook, identified by the webhook_id.

Parameters

NameInTypeRequiredDescription
webhook_idpathstringtruenone
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

200 Response
{
  "id": 0,
  "name": "string",
  "url": "string",
  "enabled": true,
  "method": "POST",
  "http_headers": [
    {
      "http_header_id": 0,
      "http_header_key": "string",
      "http_header_value": "string"
    }
  ],
  "payload_template": "{'text': 'You have new alert from PEM', 'attachments': [{'text': 'AlertID \n%AlertID% \nAlertName \n%AlertName%''}]}",
  "low_alert": true,
  "med_alert": true,
  "high_alert": true,
  "cleared_alert": true
}

Responses

StatusMeaningDescriptionSchema
200OKStatus 200Webhook
Info

This operation does not require authentication

put__webhook_{webhook_id}

Code samples

PUT /webhook/{webhook_id}

Update the webhook information.

Body parameter

{
  "name": "string",
  "url": "string",
  "enabled": true,
  "method": "POST",
  "http_headers": {
    "added": [
      {
        "http_header_key": "string",
        "http_header_value": "string"
      }
    ],
    "changed": [
      {
        "http_header_id": 0,
        "http_header_key": "string",
        "http_header_value": "string"
      }
    ],
    "deleted": [
      {
        "http_header_id": 0
      }
    ]
  },
  "payload_template": "{'text': 'You have new alert from PEM', 'attachments': [{'text': 'AlertID \n%AlertID% \nAlertName \n%AlertName%''}]}",
  "low_alert": true,
  "med_alert": true,
  "high_alert": true,
  "cleared_alert": true
}

Parameters

NameInTypeRequiredDescription
webhook_idpathstringtruenone
X-Auth-TokenheaderstringtrueToken of authorization
bodybodyWebhookPutDatatruenone

Example responses

Responses

StatusMeaningDescriptionSchema
200OKWebhook updated successfully.None

Response Schema

Info

This operation does not require authentication

delete__webhook_{webhook_id}

Code samples

DELETE /webhook/{webhook_id}

Delete the webhook.

Parameters

NameInTypeRequiredDescription
webhook_idpathstringtruenone
X-Auth-TokenheaderstringtrueToken of authorization

Example responses

Responses

StatusMeaningDescriptionSchema
200OKWebhook deleted successfullyNone

Response Schema

Info

This operation does not require authentication