Docs / Messages

`get_send_status`

Check how a background inbox refresh ended.

This action only reads. It changes nothing, so it is safe to try.

What you give it

Input	What it is	Where to get it
`taskId` needed	A task id. Task ID returned by sync_inbox, or by a queued reply.	Run `sync_inbox` and use `taskIds[]` from its answer. 1 more place to get it `sync_inbox` → `taskId`

Call it

curl -X POST https://api.heyreagent.com/v1/actions/get_send_status \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"taskId":"PASTE_TASK_ID_HERE"}'

The same call in JavaScript

const response = await fetch("https://api.heyreagent.com/v1/actions/get_send_status", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "taskId": "PASTE_TASK_ID_HERE"
  }),
});
const answer = await response.json();
console.log(answer);

The same call in Python

import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/get_send_status",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "taskId": "PASTE_TASK_ID_HERE",
    },
)
print(response.json())

The same call in n8n

Add an HTTP Request node and fill it in like this:

Method	`POST`
URL	`https://api.heyreagent.com/v1/actions/get_send_status`
Send Headers	On. Name `Authorization`, Value `Bearer YOUR_KEY`
Send Body	On. Body Content Type `JSON`, Specify Body `Using JSON`, then paste the body below

{
  "taskId": "PASTE_TASK_ID_HERE"
}

Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

`taskId`
`taskType`
`status`
`error`
`result`
`createdAt`
`updatedAt`
`completedAt`

A field that does not apply to an answer is left out, or is null.

When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.

Good to know

status is pending, processing, retrying, completed, failed or cancelled.

In Claude or ChatGPT

Once connected, ask in your own words. The assistant sees this action as a tool with the same name, get_send_status, and the same inputs.