parley
DocsPlatform
Resources
JournalIdeas on running AI supportCustomer storiesHow teams use ParleyGuidesStep-by-step playbooksChangelogWhat shipped, by versionHelp centerAnswers and support
CustomersPricing
LoginGet started
DocsPlatformCustomersPricingJournalCustomer storiesGuidesChangelogHelp center
Get startedLogin

Take charge of your AI customer experience

Get startedTalk to sales

Platform

Platform overviewChannelsPlaybooksIntegrationsAnalyticsPricing

Resources

DocumentationGuidesCustomer storiesJournalChangelogHelp center

Company

AboutCareersContact salesContact supportTerms of servicePrivacy

Security

Trust centerSOC 2ISO 27001GDPRHIPAAData processing
parley

© Parley. All rights reserved.

Docs home

Get started

Quickstart

Build your agent

PlaybooksChannelsKnowledgeActions

Developers

Parley CLICustom codeAPI keysWebhooks

Test and ship

TracesSplit testingSimulations
All docs
Docs home

Get started

Quickstart

Build your agent

PlaybooksChannelsKnowledgeActions

Developers

Parley CLICustom codeAPI keysWebhooks

Test and ship

TracesSplit testingSimulations
Docs/Developers

Webhooks

Webhooks send events to your own endpoint as conversations happen, so you can update other systems, alert your team or fill your warehouse.

Events

  • conversation.started and conversation.ended
  • message.created for customer and agent messages
  • handoff.created when a person is asked to step in
  • conversation.resolved with the outcome and its trace link
  • action.failed when an action returns an error

Payload

json
{
  "type": "conversation.resolved",
  "project": "prj_returns",
  "conversation": "conv_8f21",
  "channel": "whatsapp",
  "outcome": "resolved",
  "trace_url": "https://app.parley.ai/t/conv_8f21"
}

Verifying signatures

Each request carries a Parley-Signature header: an HMAC SHA-256 of the raw body using your endpoint secret. Reject requests whose signature doesn't match.

javascript
import crypto from "node:crypto";

export function verify(body, header, secret) {
  const mac = crypto.createHmac("sha256", secret).update(body).digest("hex");
  return crypto.timingSafeEqual(Buffer.from(mac), Buffer.from(header));
}

Retries

Parley retries failed deliveries with backoff for up to 24 hours. Respond with a 2xx within 10 seconds; do slow work after you reply.

PreviousAPI keysNextTraces

Something unclear?Contact supportor browse thehelp centerAll guides

On this page

EventsPayloadVerifying signaturesRetries