Skip to main content
POST
/
v2.0
/
endpoint
/
notify
Send a Message as an AI Agent Output
curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/endpoint/notify?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "userId": "user@example.com",
  "text": "inject text",
  "data": {},
  "URLToken": "endpoint-url-token",
  "attachments": [
    {
      "name": "<string>",
      "url": "<string>",
      "type": "file",
      "caption": "<string>"
    }
  ],
  "sessionId": "your-session-id"
}
'
"Sucessfully sent message to user"

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
ā€‹
userId
string<email>
required
Example:

"user@example.com"

ā€‹
text
string
required
Example:

"inject text"

ā€‹
data
object
required
ā€‹
URLToken
string
required
Example:

"endpoint-url-token"

ā€‹
attachments
object[]
ā€‹
sessionId
string
Example:

"your-session-id"

Response

Returns success message.