getEvent

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>'

import requests

url = "https://api.botpress.cloud/v1/chat/events/{id}"

headers = {
    "x-bp-authenticated-principal": "<x-bp-authenticated-principal>",
    "x-bot-id": "<x-bot-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'x-bp-authenticated-principal': '<x-bp-authenticated-principal>',
    'x-bot-id': '<x-bot-id>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.botpress.cloud/v1/chat/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.botpress.cloud/v1/chat/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-bot-id: <x-bot-id>",
    "x-bp-authenticated-principal: <x-bp-authenticated-principal>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.botpress.cloud/v1/chat/events/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-bp-authenticated-principal", "<x-bp-authenticated-principal>")
	req.Header.Add("x-bot-id", "<x-bot-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.botpress.cloud/v1/chat/events/{id}")
  .header("x-bp-authenticated-principal", "<x-bp-authenticated-principal>")
  .header("x-bot-id", "<x-bot-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botpress.cloud/v1/chat/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-bp-authenticated-principal"] = '<x-bp-authenticated-principal>'
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "status": "pending",
    "failureReason": "<string>",
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>"
  }
}

{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "status": "pending",
    "failureReason": "<string>",
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>"
  }
}

GET

chat

events

{id}

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>'

import requests

url = "https://api.botpress.cloud/v1/chat/events/{id}"

headers = {
    "x-bp-authenticated-principal": "<x-bp-authenticated-principal>",
    "x-bot-id": "<x-bot-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'x-bp-authenticated-principal': '<x-bp-authenticated-principal>',
    'x-bot-id': '<x-bot-id>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.botpress.cloud/v1/chat/events/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.botpress.cloud/v1/chat/events/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "x-bot-id: <x-bot-id>",
    "x-bp-authenticated-principal: <x-bp-authenticated-principal>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.botpress.cloud/v1/chat/events/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-bp-authenticated-principal", "<x-bp-authenticated-principal>")
	req.Header.Add("x-bot-id", "<x-bot-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.botpress.cloud/v1/chat/events/{id}")
  .header("x-bp-authenticated-principal", "<x-bp-authenticated-principal>")
  .header("x-bot-id", "<x-bot-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.botpress.cloud/v1/chat/events/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-bp-authenticated-principal"] = '<x-bp-authenticated-principal>'
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "status": "pending",
    "failureReason": "<string>",
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>"
  }
}

{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "status": "pending",
    "failureReason": "<string>",
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bp-authenticated-principal

string

required

Authenticated principal. Injected by the authentication middleware.

x-bot-id

string

required

Bot id

x-integration-id

string

Integration id

x-integration-alias

string

Integration alias

x-real-ip

string

Caller's IP address. Injected by the edge proxy.

Path Parameters

string

required

Event id

Response

Returns the Event object if a valid identifiers were provided. Returns an error otherwise

event

object

required

The event object represents an action or an occurrence.

Show child attributes

Last modified on July 3, 2026

Get Started

Chat API

Admin API

Files API

Tables API

Runtime API

Authorizations

Headers

Path Parameters

Response