Alerts

Test alert destination

Tests an alert destination configuration. For HTTP destinations, sends a test HTTP request to the specified endpoint. For email destinations, validates SMTP configuration and recipient permissions, then sends a test email. This allows users to verify that their destination configuration is correct before saving it.

post/api/{org_id}/alerts/destinations/test

Request

Base URL
https://api.openobserve.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/alerts/destinations/test/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

org_idstring required

Organization name

Request body

bodystring nullable

headersobject nullable

methodstring nullable

recipientsstring[] nullable

Email recipients for email destination testing

skipTlsVerifyboolean nullable

templatestring nullable

Template a slack_app test renders on a sample alert; the org default when absent.

type'http' | 'email' | 'sns' | 'slack_app'

urlstring

Example request

{
  "slackApp": {
    "channel_id": "C0FAKE00001"
  }
}

Response

Success

errorstring nullable

responseBodystring nullable

statusCodeinteger nullable

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.