Send a notification
curl --request POST \
--url https://api.arg.ai/api/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"body": "<string>",
"type": "<string>",
"target": "<string>",
"users": [
"<string>"
],
"channels": [],
"metadata": {}
}
'import requests
url = "https://api.arg.ai/api/notifications"
payload = {
"title": "<string>",
"body": "<string>",
"type": "<string>",
"target": "<string>",
"users": ["<string>"],
"channels": [],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
body: JSON.stringify('<string>'),
type: '<string>',
target: '<string>',
users: ['<string>'],
channels: [],
metadata: {}
})
};
fetch('https://api.arg.ai/api/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{}{
"detail": "<string>"
}Notifications
Send a notification
Notify yourself or another member of your organization and optionally open a specific Arg file, folder, chat, or action run. Use βmeβ or omit recipients to send to yourself.
POST
/
api
/
notifications
Send a notification
curl --request POST \
--url https://api.arg.ai/api/notifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"body": "<string>",
"type": "<string>",
"target": "<string>",
"users": [
"<string>"
],
"channels": [],
"metadata": {}
}
'import requests
url = "https://api.arg.ai/api/notifications"
payload = {
"title": "<string>",
"body": "<string>",
"type": "<string>",
"target": "<string>",
"users": ["<string>"],
"channels": [],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
body: JSON.stringify('<string>'),
type: '<string>',
target: '<string>',
users: ['<string>'],
channels: [],
metadata: {}
})
};
fetch('https://api.arg.ai/api/notifications', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{}{
"detail": "<string>"
}Authorizations
bearerAuthapiKeyAuth
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Notification title, up to 200 characters. Optional when target is provided.
Notification body.
Notification type, used for grouping and preferences.
Arg file, folder, chat, or action run URL to open.
Recipients, by "me", user id, or email. Every recipient must be in your organization. Defaults to yourself.
Delivery channels. Omit for all channels; recipient preferences still apply.
Available options:
ios, email, in-app Extra data stored with the notification.
Response
Successful response
The response is of type object.