Ingest an external event for a Kibana connector Experimental; added in 9.6.0

POST /api/actions/events/{connector_type_id}/{connector_id}
Api key auth Basic auth

Spaces method and path for this operation:

post /s/{space_id}/api/actions/events/{connector_type_id}/{connector_id}

Refer to Spaces for more information.

Public ingress for Kibana connector-scoped inbound events. Authenticate with an ingest token (Authorization: Bearer, or token query parameter as fallback). A successful emit returns 202. A connector HTTP ack returns 200 (JSON or a plain-text body) and does not emit.

Path parameters

  • connector_type_id string Required

    The Kibana connector type identifier.

    Minimum length is 1, maximum length is 64.

  • connector_id string Required

    The identifier of the Kibana connector instance that should receive the event.

    Minimum length is 1, maximum length is 36.

Query parameters

  • token string

    Connector ingest token. Prefer Authorization: Bearer <token>. Query token is only used when the Authorization header is absent.

    Minimum length is 1, maximum length is 128.

application/json; application/*+json; application/x-www-form-urlencoded; text/plain; */*

Body

Responses

  • 200 application/json; application/*+json; application/x-www-form-urlencoded; text/plain; */*

    Connector HTTP 200 ack. No event is emitted. JSON or a plain-text body.

    Connector HTTP 200 ack. JSON or a plain-text body. No event is emitted.

    Any of:
    string-1 string object-2 object

    Plain-text HTTP ack body.

    Minimum length is 1, maximum length is 8192.
  • 202 application/json; application/*+json; application/x-www-form-urlencoded; text/plain; */*

    The ingress request was accepted. Downstream emit failures may still be partial; see server logs.

    Hide response attribute Show response attribute object
    • ok boolean Required

      Indicates the ingress request was accepted for processing.
  • 403

    Inbound connector events are disabled.

  • 404

    Connector, connector type, or ingest token was not found or failed verification.

  • 429

    Inbound rate limit exceeded. Retry-After is the seconds until a request is allowed again.

  • 500

    The connector failed to handle or validate the event.

POST /api/actions/events/{connector_type_id}/{connector_id} 
curl \
 --request POST 'https://localhost:5601/api/actions/events/{connector_type_id}/{connector_id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json; application/*+json; application/x-www-form-urlencoded; text/plain; */*"
Request examples 
{
  "eventType": "order.created",
  "orderId": "1"
}
{
  "type": "ping",
  "challenge": "abc"
}
Response examples (200) 
{
  "challenge": "abc"
}
Response examples (202) 
{
  "ok": true
}