Walker Formulation Academy for developers API reference Error catalog OpenAPI
Sections

API reference

Methods of the public API. The full machine-readable OpenAPI 3.1 specification is available for download; there is no "try it" here: integration keys are never entered on the page.

Base URLs

Three independent cells. A key works only in the cell it was issued in; otherwise wrong_cell is returned.

Cell IDhttps://wfacademy.id/api/public/v1

Authorization

Header Authorization: Bearer <key>. HTTPS only.

Download OpenAPI

Methods

Account 4

MethodPathDescriptionScopesStatus
GET/meWho am I—Available
PUT/me/encryption-keyPublic key for the JWE formatwebhooks:manageAvailable
GET/walletWallet and exchange state—Available
GET/operations/{id}Get an operation—Available

Conversations 5

MethodPathDescriptionScopesStatus
GET/conversationsList conversationsconversations:readAvailable PII
POST/conversationsFind or create a conversationconversations:writeAvailable PII
GET/conversations/{id}Get a conversationconversations:readAvailable PII
GET/conversations/{id}/messagesConversation messagesconversations:readAvailable PII
POST/conversations/{id}/messagesCustomer message and AI replyconversations:writeAvailable PII

Analytics 4

MethodPathDescriptionScopesStatus
GET/analytics/timeseriesTime seriesanalytics:readAvailable
GET/analytics/traffic-sourcesTraffic sourcesanalytics:readAvailable
GET/analytics/funnelFunnelanalytics:readAvailable
GET/analytics/visibilityVisibilityanalytics:readAvailable

Dashboards 2

MethodPathDescriptionScopesStatus
GET/dashboards/overviewThe Overview dashboarddashboards:readAvailable
GET/dashboards/pulseThe Pulse dashboarddashboards:readAvailable

Leads 2

MethodPathDescriptionScopesStatus
GET/leadsList leadsleads:readAvailable PII
GET/leads/{id}Get a leadleads:readAvailable PII

Articles 2

MethodPathDescriptionScopesStatus
GET/articlesList articlesarticles:readAvailable
GET/articles/{id}Get an articlearticles:readAvailable

Strategist 6

MethodPathDescriptionScopesStatus
GET/strategist/reportsList strategist reportsstrategist:readAvailable
GET/strategist/reports/{id}Get a strategist reportstrategist:readAvailable
GET/strategist/topicsList topicsstrategist:readAvailable
GET/strategist/topics/{id}Get a topicstrategist:readAvailable
GET/strategist/actionsList strategist actions of your sessionsstrategist:readAvailable
GET/strategist/actions/{id}Get a strategist actionstrategist:readAvailable

Webhooks 8

MethodPathDescriptionScopesStatus
GET/webhooksList subscriptionswebhooks:manageAvailable
POST/webhooksCreate a subscriptionwebhooks:manageAvailable
GET/webhooks/{id}Get a subscriptionwebhooks:manageAvailable
PATCH/webhooks/{id}Update a subscriptionwebhooks:manageAvailable
DELETE/webhooks/{id}Delete a subscriptionwebhooks:manageAvailable
POST/webhooks/{id}/testSend a test eventwebhooks:manageAvailable
GET/webhooks/{id}/deliveriesDelivery logwebhooks:manageAvailable
GET/.well-known/jwks.jsonWebhook signing public keys—Available

Channels 2

MethodPathDescriptionScopesStatus
GET/channels/{id}/widgetGet chat widget settingschannels:readAvailable
PATCH/channels/{id}/widgetUpdate chat widget settingschannels:writeAvailable

Product cards 6

MethodPathDescriptionScopesStatus
GET/cardsList cardscards:readAvailable
POST/cardsCreate a cardcards:writeAvailable
GET/cards/{code}Get a cardcards:readAvailable
PATCH/cards/{code}Update a cardcards:writeAvailable
DELETE/cards/{code}Delete a cardcards:writeAvailable
POST/conversations/{id}/cardsSend cards to a conversationconversations:writeAvailable PII