Skip to main content
POST
Test application webhook

Restrictions

Usage

  • The URL must use http or https; on Flashduty cloud, hosts that resolve to private, loopback, link-local or reserved addresses are rejected with InvalidParameter.
  • The sample body has the same shape as real alert events: account_id, data_source_type (rum.alert), title, event_severity, event_status, description, alert_key, labels, and event_time (Unix seconds).
  • Each attempt times out after 10 seconds; transport errors, 5xx and 429 responses are retried up to 2 times.
  • A failed delivery still returns HTTP 200 with ok: false and the reason in message.
  • The caller must be able to edit the application: the account owner, an account admin, the application’s creator, or a member of its owning team; anyone else gets AccessDenied.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for sending a sample RUM alert webhook.

application_id
string
required

RUM application whose name is put in the sample event's labels.application_name. The caller must be able to edit it. Get application IDs via POST /rum/application/list.

webhook_url
string<uri>
required

Webhook URL to receive the sample alert event; must use http or https. Not saved: use POST /rum/application/update with alerting.webhook_url to store it.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Result of the webhook test delivery.