Inbound WhatsApp Flows completion webhook

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "encrypted_flow_data": "Q0F2MNqEYlY3MDd6U2V0cG…",
  "data": {
    "flow_id": "1219923723364737",
    "contact_id": "ct_9xT8vU1e...",
    "conversation_id": "co_1xQk..."
  }
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint"

payload = {
    "encrypted_flow_data": "Q0F2MNqEYlY3MDd6U2V0cG…",
    "data": {
        "flow_id": "1219923723364737",
        "contact_id": "ct_9xT8vU1e...",
        "conversation_id": "co_1xQk..."
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    encrypted_flow_data: 'Q0F2MNqEYlY3MDd6U2V0cG…',
    data: {
      flow_id: '1219923723364737',
      contact_id: 'ct_9xT8vU1e...',
      conversation_id: 'co_1xQk...'
    }
  })
};

fetch('https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'encrypted_flow_data' => 'Q0F2MNqEYlY3MDd6U2V0cG…',
    'data' => [
        'flow_id' => '1219923723364737',
        'contact_id' => 'ct_9xT8vU1e...',
        'conversation_id' => 'co_1xQk...'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint"

	payload := strings.NewReader("{\n  \"encrypted_flow_data\": \"Q0F2MNqEYlY3MDd6U2V0cG…\",\n  \"data\": {\n    \"flow_id\": \"1219923723364737\",\n    \"contact_id\": \"ct_9xT8vU1e...\",\n    \"conversation_id\": \"co_1xQk...\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"encrypted_flow_data\": \"Q0F2MNqEYlY3MDd6U2V0cG…\",\n  \"data\": {\n    \"flow_id\": \"1219923723364737\",\n    \"contact_id\": \"ct_9xT8vU1e...\",\n    \"conversation_id\": \"co_1xQk...\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"encrypted_flow_data\": \"Q0F2MNqEYlY3MDd6U2V0cG…\",\n  \"data\": {\n    \"flow_id\": \"1219923723364737\",\n    \"contact_id\": \"ct_9xT8vU1e...\",\n    \"conversation_id\": \"co_1xQk...\"\n  }\n}"

response = http.request(request)
puts response.read_body

"<string>"

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Channels

Inbound WhatsApp Flows completion webhook

Receives a Meta Flow-completion event when a customer finishes a multi-step interactive Flow. Authenticates using the X-Devotel-Org-Id header (org id shape-validated, then the org’s WhatsApp connection credentials + flow private key are resolved). The request body is the Meta-endpoint envelope (encrypted_flow_data, data = ); the signature is HMAC-SHA256 over the raw body using the org’s app_secret. Payloads are persisted to <tenant>.whatsapp_flow_responses keyed to the matching flow. Returns the Meta-specified AES-128-GCM-encrypted JSON as text/plain (NOT the standard { data, meta } envelope); failure replies use the uniform 401 error envelope below.

POST

api

channels

flows

endpoint

Inbound WhatsApp Flows completion webhook

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "encrypted_flow_data": "Q0F2MNqEYlY3MDd6U2V0cG…",
  "data": {
    "flow_id": "1219923723364737",
    "contact_id": "ct_9xT8vU1e...",
    "conversation_id": "co_1xQk..."
  }
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint"

payload = {
    "encrypted_flow_data": "Q0F2MNqEYlY3MDd6U2V0cG…",
    "data": {
        "flow_id": "1219923723364737",
        "contact_id": "ct_9xT8vU1e...",
        "conversation_id": "co_1xQk..."
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    encrypted_flow_data: 'Q0F2MNqEYlY3MDd6U2V0cG…',
    data: {
      flow_id: '1219923723364737',
      contact_id: 'ct_9xT8vU1e...',
      conversation_id: 'co_1xQk...'
    }
  })
};

fetch('https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'encrypted_flow_data' => 'Q0F2MNqEYlY3MDd6U2V0cG…',
    'data' => [
        'flow_id' => '1219923723364737',
        'contact_id' => 'ct_9xT8vU1e...',
        'conversation_id' => 'co_1xQk...'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint"

	payload := strings.NewReader("{\n  \"encrypted_flow_data\": \"Q0F2MNqEYlY3MDd6U2V0cG…\",\n  \"data\": {\n    \"flow_id\": \"1219923723364737\",\n    \"contact_id\": \"ct_9xT8vU1e...\",\n    \"conversation_id\": \"co_1xQk...\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"encrypted_flow_data\": \"Q0F2MNqEYlY3MDd6U2V0cG…\",\n  \"data\": {\n    \"flow_id\": \"1219923723364737\",\n    \"contact_id\": \"ct_9xT8vU1e...\",\n    \"conversation_id\": \"co_1xQk...\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/channels/whatsapp/flows/endpoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"encrypted_flow_data\": \"Q0F2MNqEYlY3MDd6U2V0cG…\",\n  \"data\": {\n    \"flow_id\": \"1219923723364737\",\n    \"contact_id\": \"ct_9xT8vU1e...\",\n    \"conversation_id\": \"co_1xQk...\"\n  }\n}"

response = http.request(request)
puts response.read_body

"<string>"

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "<string>",
    "status": 429,
    "retry_after": 2
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  },
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "docs_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Dashboard JWT token from Clerk

Headers

x-devotel-org-id

string

Orbit organization id that owns the flow (required).

x-hub-signature-256

string

HMAC-SHA256 over the raw body using the org's app_secret.

Idempotency-Key

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255

X-Test-Mode

enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:

true,

false

Body

application/json

Meta endpoint envelope: encrypted_flow_data (AES-128-GCM over RSA-OAEP-wrapped key) plus data.flow_id, contact_id, conversation_id references.

Response

Meta-specified raw base64 AES-128-GCM body sent as text/plain; this shape is Meta-mandated and intentionally NOT the standard { data, meta } envelope. Any failure branch returns the same uniform 401 (see route description).

API Reference

All Endpoints

Inbound WhatsApp Flows completion webhook

Authorizations

Headers

Body

Response