Sales Igniter Chat: REST API for developers

Sales Igniter Chat has a REST API, so your own code can read and answer chats, work with tickets and contacts, and add answers for the AI. This page lists the routes meant for your code, how to sign in, the errors, the limits and the hooks. Every example on it was run against a test site; the ids and passwords in it are made up.

The routes live under /wp-json/silc/v1/ on your WordPress site:

https://your-site.example/wp-json/silc/v1/

Before you start

  • One version. All routes are in the silc/v1 namespace. Responses gain new fields from time to time: read the fields you need and ignore the rest. The routes under “Internal routes” below serve the plugin’s own screens and can change in any release. Read the changelog before you update.
  • The full list. GET /wp-json/silc/v1 (WordPress’s own route index) lists every route and its methods.
  • Bodies are JSON (Content-Type: application/json) or form fields. Times are ISO 8601 in UTC, like 2026-10-21T14:23:55Z.
  • Ids. Conversations and contacts have 26-character ids, like 01JX4T9QZK3M7W2B8D5F6H1N0P. A ticket is a conversation too, with a number like #1042 on top.
  • No caching. Every answer is sent with Cache-Control: no-store.
  • Text, not HTML. Messages, names and notes are plain text. Show them as text, never as HTML.

Signing in

Every route needs a logged-in WordPress user with the right capability, except the short list in “Routes for the widget”. There are two ways to sign in.

From your own server: application passwords

Use WordPress’s application passwords for scripts, other servers and tools like Zapier.

  1. Make a WordPress user for the integration. Give it the Chat operator role, or a role with only the capabilities it needs (see “Who can do what” below).
  2. Open that user’s profile, go to Application Passwords, type a name and click Add New Application Password. Copy the password: WordPress shows it once.
  3. Send the user name and that password with Basic auth, over HTTPS. WordPress turns application passwords off on a site without HTTPS.
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  "https://your-site.example/wp-json/silc/v1/inbox?view=all"

Without a user, or with a wrong password:

HTTP 401
{"code": "rest_not_logged_in", "message": "Please log in again.", "data": {"status": 401}}

To stop an integration, revoke its application password on the same profile screen.

From your site’s own pages: cookie and nonce

JavaScript that runs in wp-admin or on your site’s pages can use the logged-in user’s cookie. WordPress then needs the REST nonce in an X-WP-Nonce header, made in PHP with wp_create_nonce( 'wp_rest' ):

fetch('/wp-json/silc/v1/inbox?view=mine', {
  headers: { 'X-WP-Nonce': mySettings.restNonce },
  credentials: 'same-origin',
});

With the cookie but no nonce, WordPress treats the request as logged out (401 rest_not_logged_in). A wrong or old nonce gets 403 rest_cookie_invalid_nonce.

Requests from other websites

A browser sends an Origin header with every cross-site request. When the Origin is another website, the API refuses it before any route runs:

HTTP 403
{"code": "silc_origin", "message": "This website is not connected to the chat.", "data": {"status": 403}}

The only exception is a website you connected under Settings › Sites, and only for the widget’s own routes. So call the API from your server (curl, PHP, Node: no Origin header), not from browser JavaScript on another domain.

Who can do what

The plugin adds these capabilities. Administrators have all of them. The Chat operator role has the first two. You can add any of them to another role.

CapabilityWhat it allows
silc_answer_chatsThe inbox, conversations, replies and notes, tickets, contacts, events, saved replies
silc_view_purchasesA contact’s WooCommerce and EDD purchases
silc_manage_chatsSee every conversation, reassign a colleague’s chat, delete conversations, merge and block people
silc_manage_settingsSettings, websites, mailboxes, knowledge and AI answers, routing, the audit log
silc_manage_helpdeskHelp Desk settings: teams, SLA policies, macros, ticket forms; Help Desk reports
silc_export_contactsExport and erase a person
silc_reveal_licence_keysReveal a licence key from a purchase (each reveal is in the audit log)
silc_view_client_credentials, silc_edit_client_credentialsSecure details. Given per person on the Team screen, never by role

What an operator sees. With silc_manage_chats you see every conversation. Without it, you see unassigned conversations, the ones the AI handles, and your own. A colleague’s conversation is “not found” (404 silc_not_found), never “forbidden”, so ids can’t be probed. Only managers can reassign or take over a colleague’s conversation.

Errors

Errors are WordPress’s usual JSON: a code, a message for people, and the HTTP status. The message follows the site’s language, so check the code, not the text.

{"code": "silc_not_found", "message": "This conversation was not found.", "data": {"status": 404}}
Status and codeWhen
400 silc_invalidA field is wrong. Forms that check several fields add data.fields: field name and message
400 silc_emptyThe reply or message has no text
401 rest_not_logged_inNot signed in
403 rest_forbiddenSigned in, but without the capability
403 silc_originThe request came from another website’s page
403 silc_license_requiredA change to the setup before a licence key is activated (see below)
403 silc_helpdesk_requiredA change to tickets or Help Desk settings while Help Desk is off (see below)
404 silc_not_foundNot found, or not yours to see
409A conflict, like silc_collision (a colleague replied first) or silc_not_ticket
429 silc_rate, silc_rate_limited, silc_slow_downToo many requests: wait and try again

Licence first. Until a licence key is activated under Settings › Licence, changes to settings, the setup, websites, mailboxes, routing rules, the team, proactive messages, knowledge and the AI’s Try it are refused with 403 silc_license_required. Reading is never locked. The inbox, conversations, contacts, saved replies and the widget are never locked. An expired licence never locks anything.

Help Desk. Ticket routes and Help Desk settings (tickets, teams, sla, macros, ticket-forms, reports, helpdesk, vault, import) need the Help Desk edition. While it is off, reading still works, so older tickets stay visible, but changes get 403 silc_helpdesk_required.

Conversations and messages

Needs silc_answer_chats. A conversation is a chat, an email thread or a ticket.

List conversations

GET /inbox lists 50 conversations, newest first, with the counts of every view.

ParameterWhat it does
viewall (default), mine, ai, waiting (no one has it yet), email, snoozed, resolved. With Help Desk also t:all, t:mine, t:unassigned, t:today, t:overdue, t:waiting, t:hold, t:solved and team:<id>
qSearch: name, email, reference, subject, ticket number (#1042) or message text
beforeAn ISO time: the next page of a newest-first list (pass the last row’s lastMessageAt)
siteOnly one website’s conversations (its id from GET /sites)
sort, offsetTicket views: due (default), priority or newest; page with offset (0, 50, 100 and so on)
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  "https://your-site.example/wp-json/silc/v1/inbox?view=email"
{
 "conversations": [
  {
   "id": "01JX4T9QZK3M7W2B8D5F6H1N0P",
   "ref": "D6Z8X3",
   "status": "open",
   "handler": "unassigned",
   "assignee": null,
   "title": "Lena Fischer",
   "contact": {"id": "01JX4T9QZJ8R2C6V0N4B7M1K5S", "name": "Lena Fischer", "email": "[email protected]"},
   "subject": "Paddle board for Saturday",
   "preview": "Hi, do you still have a paddle board free this Saturday morning? Lena",
   "lastAuthor": "contact",
   "lastChannel": "email",
   "unread": 1,
   "lastMessageAt": "2026-10-21T14:29:47Z",
   "snoozedUntil": null,
   "site": 1,
   "kind": "ticket",
   "ticket": {
    "number": 1004, "tag": "#1004", "stage": "new", "stageLabel": "New", "priority": "normal",
    "type": null, "team": null, "source": "email",
    "sla": {"state": "ok", "due": "2026-10-21T22:29:47Z", "target": "first"}
   }
  }
 ],
 "counts": {"all": 4, "mine": 3, "ai": 0, "waiting": 1, "email": 2, "snoozed": 0, "unread": 1,
  "t:all": 4, "t:mine": 3, "t:unassigned": 1, "t:today": 2, "t:overdue": 0, "t:waiting": 0, "t:hold": 1, "teams": {"1": 2}}
}
  • status: open, pending (snoozed or waiting on the customer) or resolved.
  • handler: ai, human or unassigned.
  • kind: chat or ticket. ticket is null for a chat.

Read a conversation

GET /conversations/{id} gives the conversation, its messages, the contact, their past conversations, email details, the AI’s state and the ticket.

GET /conversations/{id}/messages?after_seq=12 gives only the messages after number 12, with the conversation and the ticket. Each message has a seq that only goes up, so keep the last one you saw.

A message looks like this:

{
 "id": 5,
 "seq": 5,
 "author": "operator",
 "authorId": 2,
 "name": "Sam",
 "text": "Yes, you can. Which dates would you like instead?",
 "channel": "chat",
 "audience": "public",
 "delivery": "pending_chat",
 "at": "2026-10-21T14:23:55Z",
 "attachments": []
}
  • author: contact, operator, ai or system.
  • channel: chat, email, note (internal) or event (like “Sam joined.”).
  • audience: public (the customer sees it) or internal.
  • delivery: pending_chat, read, queued_email, emailed, bounced, failed, suppressed, received, received_email or none.

Reply or add a note

POST /conversations/{id}/messages

FieldWhat it does
textThe reply, up to 20,000 characters
notetrue for an internal note the customer never sees
send_asauto (default): in the chat, and by email a little later when the customer is away or doesn’t read it. chat: the chat only, never email. email_now: by email at once
attachmentsFile ids from the upload route below
resolvetrue to resolve the conversation with the reply
expect_seq, forceCollision check: the last seq you saw. If a colleague replied after it you get 409 silc_collision; send again with force: true to post anyway
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"text": "Yes, you can. Which dates would you like instead?"}' \
  "https://your-site.example/wp-json/silc/v1/conversations/01JX4T9QZK3M7W2B8D5F6H1N0P/messages"

The answer is 201 with the conversation, the new messages and the ticket. A reply to a conversation nobody has yet takes it, so the messages include “Sam joined.” first:

{
 "conversation": {"id": "01JX4T9QZK3M7W2B8D5F6H1N0P", "status": "open", "handler": "human",
  "assignee": {"id": 2, "name": "Sam"}, "lastSeq": 5},
 "messages": [
  {"seq": 4, "author": "system", "text": "Sam joined.", "channel": "event", "audience": "public", "system": "joined"},
  {"seq": 5, "author": "operator", "name": "Sam", "text": "Yes, you can. Which dates would you like instead?",
   "channel": "chat", "audience": "public", "delivery": "pending_chat"}
 ],
 "ticket": null
}

Errors: 400 silc_empty (“Write a reply first.”), 400 silc_send_as (an unknown send_as), 409 silc_collision.

Send a file

Upload the file first, as multipart/form-data with the field file, then pass its id in attachments:

curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -F "[email protected];type=text/plain" \
  "https://your-site.example/wp-json/silc/v1/conversations/01JX4T9QZK3M7W2B8D5F6H1N0P/attachments"
HTTP 201
{"attachment": {"id": 31, "name": "boards.txt", "mime": "text/plain", "bytes": 28, "image": false,
 "url": "https://your-site.example/wp-json/silc/v1/attachments/31?exp=1793232000&sig=4be1c0d9e7a2f3b6c8d5e4f1a0b9c7d2"}}
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"text": "Board sizes for Saturday.", "note": true, "attachments": [31]}' \
  "https://your-site.example/wp-json/silc/v1/conversations/01JX4T9QZK3M7W2B8D5F6H1N0P/messages"

The file’s type is checked from its bytes (images, PDF, text, CSV, ZIP, Word, Excel; nothing executable). The url is a signed link that works for about a week. Without the signature, a file opens only for an operator who may see that conversation.

Assign, snooze and resolve

PATCH /conversations/{id} with any of:

FieldWhat it does
assigneeA user id, or null to unassign. That user needs silc_answer_chats (else 400 silc_assignee)
statusresolved or open
snoozeAn ISO time, "reply" (until the customer writes), or null to wake it now
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"snooze": "2026-10-23T09:00:00Z"}' \
  "https://your-site.example/wp-json/silc/v1/conversations/01JX4T9QZK3M7W2B8D5F6H1N0P"
{"conversation": {"id": "01JX4T9QZK3M7W2B8D5F6H1N0P", "status": "pending", "handler": "human",
 "assignee": {"id": 3, "name": "Priya"}, "snoozedUntil": "2026-10-23T09:00:00Z"}, "ticket": null}

More actions, all POST /conversations/{id}/<action>:

ActionWhat it does
takeoverYou take the conversation from the AI or from no one
handbackHands it back to the AI, with an optional note for it (409 silc_ai_off when the AI Chatbot is off)
resolve, reopenResolves or reopens it
readMarks it read up to seq (the customer’s chat shows “Seen”)
remindersGET lists your reminders; POST with due (ISO time) and note adds one. DELETE /reminders/{id} removes one

Many at once

POST /conversations/bulk with ids (up to 100) and an action: resolve, reopen, assign (with assignee), snooze (with snooze), wake, read or delete (managers only).

curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"ids": ["01JX4T9QZK3M7W2B8D5F6H1N0P", "01JX4TB2W8E5R3T1Y9U7I6O4P2"], "action": "read"}' \
  "https://your-site.example/wp-json/silc/v1/conversations/bulk"
{"done": 2, "failed": [], "counts": {"all": 3, "mine": 3, "waiting": 0, "...": "..."}}

The others still go when one fails. failed is then an object of id and reason, like {"01JX4TC7M2N9B5V1X8Z4Q6W3E0": "Not found."}, and an empty list ([]) when nothing failed.

Start a conversation

POST /contacts/{id}/message with text (up to 5,000 characters) and an optional subject starts a new conversation with someone you already know. You are its operator. It goes to their chat when they are on the site, else by email like any reply.

HTTP 201
{"conversation": "01JX4TB2W8E5R3T1Y9U7I6O4P2"}

Delete a conversation

DELETE /conversations/{id} (needs silc_manage_chats) deletes the conversation with its messages, files and emails, and writes it to the audit log. It can’t be undone.

{"deleted": "01JX4T9QZK3M7W2B8D5F6H1N0P", "counts": {"all": 2, "...": "..."}}

Tickets (Help Desk)

Needs silc_answer_chats and the Help Desk edition. A ticket is a conversation with a number, a status, a priority, a type, a team and an SLA clock. The conversation routes above work on tickets too.

The ticket settings

GET /helpdesk gives what the other ticket routes accept: the teams, the ticket types, the priorities, the statuses and the SLA policies.

Open a ticket

POST /tickets/new opens a ticket for a customer, as an email from you.

FieldWhat it does
emailThe customer’s email address (required)
nameTheir name
subjectUp to 150 characters (required)
messageUp to 20,000 characters (required)
sendtrue (default) emails the message to the customer. false keeps it as an internal note and sends nothing
prioritylow, normal, high or urgent
typeOne of the ticket types from GET /helpdesk
teamA team id from GET /helpdesk
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "name": "Oliver Brandt", "subject": "Paddle board damage report",
       "message": "Board 4 came back with a crack in the fin box. Photos attached in the shop log.",
       "send": false, "priority": "high", "type": "Damage report", "team": 1}' \
  "https://your-site.example/wp-json/silc/v1/tickets/new"
HTTP 201
{"id": "01JX4TD5H3J1K9L7Z5X3C1V9B7", "ticket": {"number": 1003, "tag": "#1003"}, "sent": false}

A missing or wrong field gets 400 silc_invalid with each field’s message:

{"code": "silc_invalid", "message": "Please check the highlighted fields.", "data": {"status": 400,
 "fields": {"email": "Enter the customer’s email address.", "subject": "Add a subject.", "message": "Write the message."}}}

send: true needs a mailbox under Settings › Email. A blocked customer gets 409 silc_blocked.

POST /tickets/convert with conversation (its id) and optional priority, type and team turns a chat into a ticket.

Read and change a ticket

GET /tickets/{id} gives the ticket’s details: status, priority, type, team, SLA targets, CC addresses, the linked order or booking, and when it was solved and closed. A chat that is no ticket gets 409 silc_not_ticket.

PATCH /tickets/{id} with any of:

FieldValues
stageopen, on_hold, waiting (waiting on the customer), solved or closed. new and snoozed are set by the plugin
prioritylow, normal, high or urgent
typeA ticket type from GET /helpdesk
teamA team id, or 0 for no team
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"stage": "on_hold", "priority": "urgent", "team": 1}' \
  "https://your-site.example/wp-json/silc/v1/tickets/01JX4TB2W8E5R3T1Y9U7I6O4P2"
{"conversation": {"id": "01JX4TB2W8E5R3T1Y9U7I6O4P2", "kind": "ticket",
 "ticket": {"number": 1002, "tag": "#1002", "stage": "on_hold", "stageLabel": "On hold", "priority": "urgent",
  "type": "Booking change", "team": 1, "source": "chat", "sla": {"state": "paused", "due": null, "target": null}}}}

The SLA clock runs only while a ticket is New or Open. A status the API can’t set gets 400 silc_invalid (“That status can’t be chosen.”), and an unknown team gets 400 too.

More ticket routes:

RouteWhat it does
GET /tickets/find?q=Up to 10 tickets by number (#1042), subject, or the customer’s name or email
POST /tickets/{id}/ccAdds a CC address (email, name), up to 10. Not the customer’s own address or a mailbox (400)
POST /tickets/{id}/cc/removeRemoves one (email)
POST /tickets/{id}/mergeMerges this ticket into another (into: its id or number)
POST /tickets/{id}/draft, /summaryThe AI drafts a reply or a summary (needs the AI Chatbot on with a key)

Reports

GET /reports/tickets gives the numbers of Help Desk › Reports: tickets created and solved, the backlog, the median first reply and resolution times, SLA met and good ratings, each with the period before. It needs silc_manage_helpdesk or silc_manage_chats.

ParameterWhat it does
from, toDates as YYYY-MM-DD (default: the last 30 days; at most 731 days)
splitchannel, team, agent, type or website
site, team, typeOnly those tickets
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  "https://your-site.example/wp-json/silc/v1/reports/tickets?from=2026-10-01&to=2026-10-21&split=channel"
{
 "range": {"from": "2026-10-01", "to": "2026-10-21", "timezone": "+00:00", "days": 21,
  "previous": {"from": "2026-09-10", "to": "2026-09-30"}},
 "tiles": {
  "created": {"value": 4, "previous": 0},
  "solved": {"value": 0, "previous": 0},
  "backlog": {"now": 4, "atStart": 0},
  "firstResponseMedian": {"minutes": 0, "previous": null},
  "slaMet": {"pct": null, "met": 0, "of": 0, "previous": null}
 },
 "split": {"by": "channel", "rows": [{"key": "email", "label": "Email", "created": 2, "solved": 0, "backlog": 2}]}
}

GET /reports/tickets/export takes the same parameters plus what (table or tickets) and answers with a CSV file. Cells that start like a formula are made safe for spreadsheets, and each export is in the audit log.

Contacts

Needs silc_answer_chats. A contact is a person who chatted or emailed.

RouteWhat it does
GET /contacts50 per page: filter (all, known, customers, online, blocked, and duplicates for people who may merge: records whose email another live record has too), q (name or email), page
GET /contacts/{id}One person: details, identities, consent, location, their conversations, and sameEmail (other live records with the same email and what each proved; empty without silc_manage_chats)
PATCH /contacts/{id}Changes name, email, phone, company, segments (up to 20 tags), website, platform
GET /contacts/{id}/purchasesWooCommerce and EDD purchases (silc_view_purchases)
GET /contacts/{id}/facts, POSTThings the team noted: text and kind (fact, or note for a private note)
PATCH /facts/{id}, DELETE /facts/{id}Changes or removes one. A private note only by its author or a manager
POST /contacts/{id}/mergeMerges other into this person (silc_manage_chats)
POST /contacts/{id}/block, /unblockBlocks or unblocks them (silc_manage_chats)
GET /contacts/{id}/exportEverything about them, in WordPress’s personal data format (silc_export_contacts)
POST /contacts/{id}/eraseDeletes them and everything about them; needs {"confirm": true} (silc_export_contacts)
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  "https://your-site.example/wp-json/silc/v1/contacts?q=maya"
{"contacts": [{"id": "01JX4TF8N6M4Q2W0E8R6T4Y2U0", "name": "Maya Lindqvist", "email": "[email protected]",
 "emailVerified": false, "company": null, "blocked": false, "customer": false, "conversations": 2, "online": false,
 "lastSeenAt": "2026-10-21T14:23:28Z", "createdAt": "2026-10-21T14:23:28Z"}], "total": 1, "page": 1, "pages": 1}
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"company": "Fjord Outfitters", "phone": "+1 555 0142", "segments": ["kayak", "returning"]}' \
  "https://your-site.example/wp-json/silc/v1/contacts/01JX4TF8N6M4Q2W0E8R6T4Y2U0"
{"contact": {"id": "01JX4TF8N6M4Q2W0E8R6T4Y2U0", "name": "Maya Lindqvist", "email": "[email protected]",
 "emailVerified": false, "phone": "+1 555 0142", "company": "Fjord Outfitters", "segments": ["kayak", "returning"],
 "conversations": [{"id": "01JX4T9QZK3M7W2B8D5F6H1N0P", "subject": "Kayak booking dates", "status": "open"}]}}
  • An email address you set is a claim, not a proof: emailVerified stays false until the person confirms it with a code.
  • An operator who isn’t a manager sees only the conversations they may open in conversations.
  • Erasing without confirm gets 400 silc_confirm. Their tickets are kept without anything about them (the number, dates, status and the like stay), so reports still add up. See Privacy and security. With confirm:
{"erased": true, "removed": {"messages": 15, "email_outbound": 3, "events": 21, "tickets_anonymised": 2, "visitors": 1,
 "contact_facts": 1, "contact_identities": 1, "contacts": 1}}

Answers for the AI

Needs silc_manage_settings. Answers are your own questions and answers. The AI trusts them most, above your pages.

RouteWhat it does
POST /kb/answersAdds one: from (the website id that keeps it), question (at least 3 characters), answer, link (an optional https:// page), on (default true)
PUT /kb/answers/{doc}Changes question, answer, link or on
DELETE /kb/answers/{doc}Deletes it
POST /kb/answers/listLists them: from, q, page
POST /kb/answers/importAdds rows from a CSV (from, csv: the columns question,answer,link,on)
GET /kb/answers/export?from=1The same CSV: {"csv": "...", "filename": "..."}
POST /kb/testWhat the AI would find for a question: q, for (the website whose AI to ask), page
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"from": 1, "question": "Can I change the dates of a kayak booking?",
       "answer": "Yes. Reply to your booking email or ask in the chat at least 48 hours before the start, and we move it to any free dates.",
       "link": "https://your-site.example/kayaks/"}' \
  "https://your-site.example/wp-json/silc/v1/kb/answers"
HTTP 201
{"answer": {"doc": 870, "question": "Can I change the dates of a kayak booking?",
 "answer": "Yes. Reply to your booking email or ask in the chat at least 48 hours before the start, and we move it to any free dates.",
 "link": "https://your-site.example/kayaks/", "on": true, "updatedAt": "2026-10-21T14:26:25Z"},
 "picks": [{"from": 1, "rule": "type", "ref": "docs"}, {"from": 1, "rule": "source", "ref": "53"}]}

The new answer is used by that website’s AI at once: picks is that AI’s knowledge list, and it now holds the website’s Answers ("rule": "source"). Send for with another website’s id to give the answer to that website’s AI. Anything in the question or answer that looks like a password or a key is masked before it is kept.

Check what the AI finds:

curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"q": "Can I move my kayak booking to other dates?", "for": 1}' \
  "https://your-site.example/wp-json/silc/v1/kb/test"
{
 "rows": [
  {"rank": 1, "doc": 870, "title": "Can I change the dates of a kayak booking?",
   "url": "https://your-site.example/kayaks/", "site": 1, "trust": "answer", "label": "Your answer", "weight": 1.4,
   "text": "Yes. Reply to your booking email or ask in the chat at least 48 hours before the start, and we move it to any free dates."}
 ],
 "confident": true,
 "search": {"keyword": 50, "semantic": 0}
}

Websites

Needs silc_manage_settings. GET /sites lists your websites: this one (site 1) and the ones you connected under Settings › Sites, with each one’s key (it is in the install snippet), addresses and licence state. See One inbox for several websites.

{"sites": [{"id": 1, "name": "Kayak Rentals", "letters": "KR", "home": true, "host": "your-site.example",
 "key": "k3v9q2m7x4b8n1c6z5w0", "mainUrl": "https://your-site.example/", "addresses": ["https://your-site.example"],
 "licence": {"state": "valid", "ok": true}, "widgetOn": true}]}

The change ping. When a connected website’s pages change, it can ask for them to be read again: POST /sites/changed?site=KEY. It needs no sign-in, carries no secret and no content, and only makes the public pages be read again within about a minute (at most once every 2 minutes per website, 30 pings a minute per IP).

curl -X POST "https://your-site.example/wp-json/silc/v1/sites/changed?site=k3v9q2m7x4b8n1c6z5w0"
HTTP 202
{"ok": true, "read": "scheduled"}

read is scheduled, later (pinged in the last 2 minutes) or unused (no AI reads that website). An unknown key gets 404.

Email in by webhook

Many email services can post each email they receive to a web address. Set a mailbox to Webhook under Settings › Email (or with POST /mailboxes, silc_manage_settings), and each email becomes a conversation or a reply in one.

curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  -H "Content-Type: application/json" \
  -d '{"name": "Help", "address": "[email protected]", "intake": "webhook"}' \
  "https://your-site.example/wp-json/silc/v1/mailboxes"
HTTP 201
{"mailbox": {"id": 4, "name": "Help", "address": "[email protected]", "intake": "webhook", "enabled": true,
 "webhookUrl": "https://your-site.example/wp-json/silc/v1/inbound/4", "webhookToken": "Rk7tQ2vX9mB4nP8sL1cW6zY3",
 "hasWebhookToken": true}}

The webhookToken is shown this once. Only a hash of it is kept, so later reads show "webhookToken": null. For a new token, call POST /mailboxes/{id}/token; the old one stops working.

Your email service then posts each email to POST /inbound/{mailbox}, with the token as ?token=, as Authorization: Bearer <token>, or as an X-SILC-Token header. The body can be the raw email (MIME), JSON with raw (the email, as text or base64) or raw_mime, or Brevo’s inbound parsing JSON.

curl -X POST -H "Content-Type: message/rfc822" --data-binary @email.eml \
  "https://your-site.example/wp-json/silc/v1/inbound/4?token=Rk7tQ2vX9mB4nP8sL1cW6zY3"
HTTP 202
{"received": [{"id": 1, "status": "queued"}]}
  • The email is stored first and answered with 202. It is read a moment later, at the latest by the plugin’s minute job.
  • A wrong token or mailbox gets the same 404 as a route that doesn’t exist. 20 wrong tries an hour from one IP get 429 silc_slow_down.
  • A body that is no email gets 400 silc_not_email.
  • Add &priority=urgent (or low, normal, high) to the webhook address to set the priority of a new ticket. It does nothing for a reply.

See Tickets by email for the other ways in (IMAP and a pipe).

Events

To learn about new messages without asking for every conversation, poll GET /events?scope=operator (silc_answer_chats). The first call, without a cursor, only gives the current cursor:

curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  "https://your-site.example/wp-json/silc/v1/events?scope=operator"
{"cursor": 76, "events": []}

Then pass the cursor back. Add watch[]=<id> (up to 20) for the messages of conversations you follow:

curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" \
  "https://your-site.example/wp-json/silc/v1/events?scope=operator&cursor=76&watch[]=01JX4T9QZK3M7W2B8D5F6H1N0P"
{
 "cursor": 83,
 "events": [
  {"id": 78, "conversation": null, "type": "conversation.changed",
   "payload": {"id": "01JX4T9QZK3M7W2B8D5F6H1N0P", "status": "open", "handler": "human", "last_channel": "email"}},
  {"id": 81, "conversation": "01JX4T9QZK3M7W2B8D5F6H1N0P", "type": "message.created",
   "payload": {"seq": 4, "author": "operator", "channel": "chat", "audience": "public"}},
  {"id": 83, "conversation": "01JX4T9QZK3M7W2B8D5F6H1N0P", "type": "delivery.changed",
   "payload": {"seq": 4, "delivery": "queued_email"}}
 ]
}
  • conversation.changed comes for every conversation, with ids and states only. Message events come only for the conversations in watch[] that you may see.
  • Other types include status.changed, typing, seen and email.received.
  • Events carry no message text: fetch it with GET /conversations/{id}/messages?after_seq=.
  • Up to 200 events per call, and events are kept for one hour. Poll every few seconds to a minute.
  • On your own server, the silc_event action gives you the same events as they happen (see “Hooks”).

Settings and the audit log

Needs silc_manage_settings.

  • GET /settings/{screen} reads one screen’s settings (ai, email, helpdesk, knowledge, notifications, operators, privacy, realtime, routing, widget, or all). GET /settings/schema lists the screens and every key with its type, default and limits.
  • PATCH /settings/{screen} changes only the keys you send, and answers with the screen’s settings. A key from another screen gets 400 silc_invalid_settings, with the key in data.fields.
  • GET /settings/export gives every setting without the secrets; POST /settings/import takes that file back.
  • GET /audit lists who revealed a key, exported or deleted a person or conversation, merged, blocked or changed rules, newest first (limit, and before with a row id for the next page). Rows hold ids and counts, never message text.
curl -u "zapier-bot:abcd EFGH ijkl MNOP qrst UVWX" -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"values": {"privacy.rate_ip_hour": 60}}' \
  "https://your-site.example/wp-json/silc/v1/settings/privacy"
{"values": {"privacy.consent": "auto", "privacy.terms_line": true, "privacy.rate_visitor_10min": 20,
 "privacy.rate_ip_hour": 60, "...": "..."}}

Secrets (AI keys, mailbox passwords, the socket secret) are never sent back. You see only whether one is set:

"ai.anthropic_key": {"set": true, "last4": "Q7xZ", "saved_at": "2026-10-20T09:14:02Z", "readable": true}

To keep a secret as it is, leave it out or send null. To remove it, send {"delete": true} as its value.

Secure details

Secure details (Help Desk) keep your customers’ logins encrypted. Their routes (/vault/... for staff, /my/vault/... for a logged-in customer) exist for the plugin’s own screens. What an integrator needs to know:

  • Every staff route needs silc_answer_chats. Everyone who answers chats sees an entry’s name and type only.
  • Showing or copying a value needs silc_view_client_credentials and the person’s WordPress password typed again in the last 5 minutes, in the same login session. An application password has no login session, so a value can’t be read with an application password.
  • Adding, replacing and deleting need silc_edit_client_credentials and the same check. Every reveal and change is recorded, and giving or taking either capability emails every administrator.
  • Customers’ own routes take a value in and never give it back, not even to its owner. 20 changes an hour.
  • Values never appear in other routes, events, emails, exports, reports or the AI.

See Secure details.

Routes for the widget

These routes serve the chat widget, the ticket form and file links. They need no sign-in, so each has its own guard. Don’t build on them: they can change in any release.

RouteGuard
GET /widget/statusPublic: online or not, office hours, the first names of up to 3 operators who are online
GET /widget/cartThe X-SILC: 1 header; the caller’s own cart only
POST /widget/triggers/{id}/shown, /openedProactive message counters: the X-SILC: 1 header and 30 an hour per IP
/visitor/...The X-SILC: 1 header (403 silc_header without it) and the visitor’s device cookie. A visitor only reaches their own conversations; any other is “not found”
/visitor/tickets/...The same, for My support tickets
GET /events (without scope=operator)The header and the device: only that visitor’s conversations
wp-content/plugins/silivechat/poll.php?r=events, ?r=beat, ?r=presenceThe fast lane (2.0.3): GET /events, POST /visitor/beat and POST /presence answered by the same REST server with the same guards (it loads fewer plugins first). Any other r is 404. Answers carry X-SILC-Lane: fast or full and are never cached. Use the REST routes in your own code
GET /attachments/{id}A signed, expiring link, or an operator who may see the conversation
POST /realtime/authThe socket server’s channel check: a capability or the device, per channel
GET /embed?site=KEYThe install script for a connected website
POST /sites/changed?site=KEYSee “Websites” above
POST /inbound/{mailbox}The mailbox’s webhook token
/my/vault/...A logged-in customer, their own entries only

Messages from visitors are limited per browser and per IP (see “Limits”).

Internal routes

The plugin’s own screens use more routes. They are not meant for your code and can change in any release: presence, sidebar, views, operators, shortcuts, visitors/..., geo, routing-rules, team, triggers, notifications/..., realtime/..., setup, ai/..., kb/... (other than kb/answers and kb/test), macros/..., ticket-forms, teams and sla changes, mailboxes/.../test, import/... and vault/....

Limits

WhatLimit
Messages from one visitor’s browser20 per 10 minutes (Settings › Privacy)
Messages from one visitor’s IP60 per hour (Settings › Privacy)
AI answers in one conversation6 per minute
Suggest a reply, AI ticket drafts and summaries20 per 10 minutes per operator
The AI’s Try it30 per 10 minutes per operator
Knowledge tests (kb/test)60 per 10 minutes
Wrong webhook tokens20 per hour per IP
The change ping30 per minute per IP
Inbound email20 per sender per hour, 100 per day, 300 per mailbox per hour
Typing events1 per 2 seconds per conversation

Over a limit you get 429. Wait a moment and try again; don’t retry in a tight loop. Behind a proxy, see Privacy and security for how the visitor’s IP is found.

Hooks

On your own server, actions and filters are often simpler than the API. All are prefixed silc_.

Actions

ActionFires whenArguments
silc_eventAny event that GET /events returnschannel, type, payload, event id
silc_conversation_startedA visitor starts a chat or sends the ticket formconversation, first message
silc_ticket_created_by_agentPOST /tickets/new (or New ticket in the inbox)conversation, ticket, user
silc_ticket_form_sentA customer sends the ticket formconversation, ticket
silc_ticket_by_ruleA chat rule turns a chat into a ticketconversation, ticket, reason
silc_asked_for_personA visitor or the AI asks for a personthe change, visitor or ai
silc_ai_handoffThe AI hands a conversation to a personconversation, reason
silc_ai_stepped_inThe AI steps in because nobody replied in timethe change
silc_conversation_deletedA conversation is deletedits id
silc_contacts_mergedTwo people are mergedthe kept person’s id, the merged one’s id
silc_contact_erasedA person is erasedtheir internal id, their id
silc_settings_updatedSettings are savedthe changed keys, the settings
silc_register_routesThe plugin has added its routesthe plugin
silc_bootedThe plugin is loadedthe plugin

silc_event gets the payload the moment the event happens. When the typing preview is on (Settings › Privacy), a visitor’s typing event carries what they are writing, so treat that payload with the same care as a message.

Filters

silc_visitor_consent, silc_wp_has_consent, silc_wp_consent_cookie_prefix, silc_show_widget, silc_route_new_chat, silc_operator_available, silc_notify_recipients, silc_purchase_sources, silc_kb_post_types, silc_kb_wants_post, silc_kb_post_html, silc_kb_rendered, silc_kb_max_files, silc_kb_pdf_max_bytes, silc_kb_product_aliases, silc_ai_system_prompt, silc_ai_models, silc_ai_prices, silc_ai_tools, silc_email_template, silc_mail_transport, silc_cookie_options, silc_client_ip, silc_trusted_proxy_ranges, silc_modules, silc_fast_lane_plugins (the plugins the fast lane, poll.php, loads besides this one; only active plugins), and for the API: silc_locked_routes (the route prefixes locked until a licence key is active) and silc_own_origins (more addresses of this same site, for the Origin check).

Good practice

  • Give each integration its own WordPress user and application password, with only the capabilities it needs. Revoke the password when you stop using it.
  • Call the API over HTTPS, from your server. Never put an application password in a web page.
  • Keep the webhook token as secret as a password. If it leaks, make a new one.
  • Never log full responses: they hold names, email addresses and messages.
  • Messages are plain text. Show them as text, never as HTML.
Scroll to Top