OutFlo Public API / Guide

Webhooks and events

Retrieve the conversation and workspace context used by event-driven integrations.

Overview

These read operations supply the conversation, message, and workspace context commonly needed after receiving an event. Their contracts use the same parameter and response conventions as every other public endpoint.

Authentication

Send the same x-api-key header with every request.

Manage API keys

Canonical contract

Request and response schemas

Every operation below follows the same contract order. All responses use the standard status, data, and error envelope.

GET/api/public/conversationsList conversations

Headers

Field	Type	Required	Description
x-api-key	string	Yes	Workspace API key.

Path parameters

No path parameters.

Query parameters

Field	Type	Required	Description
page	integer	No	Page number, starting at 1.Example: `1`
pageSize	integer	No	Results per page, up to 100.Example: `25`
fromDate	string · date-time	No	Inclusive ISO 8601 start timestamp.
toDate	string · date-time	No	Inclusive ISO 8601 end timestamp.
searchText	string	No	Search attendee names and LinkedIn profile URLs.
accountIDs	string · CSV	No	Comma-separated sender account UUIDs.
campaign_ids	string · CSV	No	Comma-separated campaign UUIDs.
tag_ids	string · CSV	No	Comma-separated numeric tag IDs.
reply_tag	enum	No	INTERESTED, NOT_INTERESTED, or GENERIC.
is_starred	boolean	No	Filter starred conversations.
isArchived	boolean	No	Filter archived conversations.
show_sent_messages	boolean	No	Include conversations with sent campaign messages.
show_responses	boolean	No	Only include conversations that have responses.
include_messages	boolean	No	Embed recent messages in each conversation.
message_limit	integer	No	Embedded messages per conversation, up to 100.Example: `25`

Request body

No request body.

Success response · 200

Field	Type	Required	Description
status	integer	Yes	HTTP status mirrored in the JSON body. Success: 200.
data	object \| array \| null	Yes	List conversations result. The exact data fields depend on the selected resource.
error	string \| null	Yes	Null on success; a developer-readable message on failure.

Query example

{
  "page": 1,
  "pageSize": 25,
  "fromDate": "<string>",
  "toDate": "<string>",
  "searchText": "<string>",
  "accountIDs": "<string>",
  "campaign_ids": "<string>",
  "tag_ids": "<string>",
  "reply_tag": "<string>",
  "is_starred": false,
  "isArchived": false,
  "show_sent_messages": false,
  "show_responses": false,
  "include_messages": false,
  "message_limit": 25
}

Standard success envelope · 200

{
  "status": 200,
  "data": "<endpoint-specific response data>",
  "error": null
}

Standard error envelope

{
  "status": 400,
  "data": null,
  "error": "Developer-readable error message"
}

GET/api/public/conversations/{id}/messagesList messages in a conversation

Headers

Field	Type	Required	Description
x-api-key	string	Yes	Workspace API key.

Path parameters

Field	Type	Required	Description
id	string · UUID	Yes	id path identifier.

Query parameters

No query parameters.

Request body

No request body.

Success response · 200

Field	Type	Required	Description
status	integer	Yes	HTTP status mirrored in the JSON body. Success: 200.
data	object \| array \| null	Yes	List messages in a conversation result. The exact data fields depend on the selected resource.
error	string \| null	Yes	Null on success; a developer-readable message on failure.

Request example

{
  "headers": {
    "x-api-key": "<string>"
  }
}

Standard success envelope · 200

{
  "status": 200,
  "data": "<endpoint-specific response data>",
  "error": null
}

Standard error envelope

{
  "status": 400,
  "data": null,
  "error": "Developer-readable error message"
}

GET/api/public/contextGet workspace context for integrations

Headers

Field	Type	Required	Description
x-api-key	string	Yes	Workspace API key.

Path parameters

No path parameters.

Query parameters

No query parameters.

Request body

No request body.

Success response · 200

Field	Type	Required	Description
status	integer	Yes	HTTP status mirrored in the JSON body. Success: 200.
data	object \| array \| null	Yes	Get workspace context for integrations result. The exact data fields depend on the selected resource.
error	string \| null	Yes	Null on success; a developer-readable message on failure.

Request example

{
  "headers": {
    "x-api-key": "<string>"
  }
}

Standard success envelope · 200

{
  "status": 200,
  "data": "<endpoint-specific response data>",
  "error": null
}

Standard error envelope

{
  "status": 400,
  "data": null,
  "error": "Developer-readable error message"
}