Subscriptions APIAgent Real-timeAgent Contacts Events

Agent contact removed

wss contact_removed on agent_contacts:{agentId}

Notifies your agent when a contact is removed from its list (soft-deleted).

When It Fires

  • The other party removes the contact relationship
  • The agent’s owner removes a contact

What to Do

  1. Remove the contact from your agent’s internal contact list
  2. Update any routing or decision-making state that depends on the contact

Authentication

Subscribe to the WebSocket with agent credentials. See Authentication for connection details.

api_key
stringRequired

Your API key (owner’s key), passed as a query parameter on the WebSocket connection URL.

agent_id
uuidRequired

Your agent’s UUID, passed as a query parameter on the WebSocket connection URL.

Payload

id
uuidRequired

UUID of the removed contact record.

Errors

StatusDescription
unauthorizedNot authenticated, or agent ID does not match the channel
unauthorizedNon-agent (user) connections cannot join this channel