Inbound Apple Messages for Business webhook

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/channels/amb/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "apple:com.acme.store",
  "conversation_id": "conv-9f2e1c87",
  "message_type": "text",
  "text": "Where is my order?",
  "received_at": "2026-08-23T14:05:00.000Z"
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/channels/amb/webhook"

payload = {
    "business_id": "apple:com.acme.store",
    "conversation_id": "conv-9f2e1c87",
    "message_type": "text",
    "text": "Where is my order?",
    "received_at": "2026-08-23T14:05:00.000Z"
}
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({
    business_id: 'apple:com.acme.store',
    conversation_id: 'conv-9f2e1c87',
    message_type: 'text',
    text: 'Where is my order?',
    received_at: '2026-08-23T14:05:00.000Z'
  })
};

fetch('https://api.orbit.devotel.io/api/v1/channels/amb/webhook', 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/amb/webhook",
  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([
    'business_id' => 'apple:com.acme.store',
    'conversation_id' => 'conv-9f2e1c87',
    'message_type' => 'text',
    'text' => 'Where is my order?',
    'received_at' => '2026-08-23T14:05:00.000Z'
  ]),
  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/amb/webhook"

	payload := strings.NewReader("{\n  \"business_id\": \"apple:com.acme.store\",\n  \"conversation_id\": \"conv-9f2e1c87\",\n  \"message_type\": \"text\",\n  \"text\": \"Where is my order?\",\n  \"received_at\": \"2026-08-23T14:05:00.000Z\"\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/amb/webhook")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_id\": \"apple:com.acme.store\",\n  \"conversation_id\": \"conv-9f2e1c87\",\n  \"message_type\": \"text\",\n  \"text\": \"Where is my order?\",\n  \"received_at\": \"2026-08-23T14:05:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/channels/amb/webhook")

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  \"business_id\": \"apple:com.acme.store\",\n  \"conversation_id\": \"conv-9f2e1c87\",\n  \"message_type\": \"text\",\n  \"text\": \"Where is my order?\",\n  \"received_at\": \"2026-08-23T14:05:00.000Z\"\n}"

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

{
  "data": {
    "accepted": true,
    "persisted": true,
    "message_id": "<string>"
  },
  "meta": {}
}

{
  "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 Apple Messages for Business webhook

Receives inbound AMB messages (text, list-picker, form reply, time-picker, Apple Pay events) from Apple. Uses the Authorization: Bearer <jwt> header for HMAC verification per RFC 7515; the router performs a bounded cross-tenant candidate sweep over amb_business_registry and picks the tenant whose secret validates the JWS signing-input. Verified messages are persisted into the tenant inbox before this endpoint acknowledges with { accepted: true }. Persistence failures are logged but acknowledged (Apple retries aggressively on 4xx/5xx).

POST

api

channels

amb

webhook

Inbound Apple Messages for Business webhook

curl --request POST \
  --url https://api.orbit.devotel.io/api/v1/channels/amb/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_id": "apple:com.acme.store",
  "conversation_id": "conv-9f2e1c87",
  "message_type": "text",
  "text": "Where is my order?",
  "received_at": "2026-08-23T14:05:00.000Z"
}
'

import requests

url = "https://api.orbit.devotel.io/api/v1/channels/amb/webhook"

payload = {
    "business_id": "apple:com.acme.store",
    "conversation_id": "conv-9f2e1c87",
    "message_type": "text",
    "text": "Where is my order?",
    "received_at": "2026-08-23T14:05:00.000Z"
}
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({
    business_id: 'apple:com.acme.store',
    conversation_id: 'conv-9f2e1c87',
    message_type: 'text',
    text: 'Where is my order?',
    received_at: '2026-08-23T14:05:00.000Z'
  })
};

fetch('https://api.orbit.devotel.io/api/v1/channels/amb/webhook', 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/amb/webhook",
  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([
    'business_id' => 'apple:com.acme.store',
    'conversation_id' => 'conv-9f2e1c87',
    'message_type' => 'text',
    'text' => 'Where is my order?',
    'received_at' => '2026-08-23T14:05:00.000Z'
  ]),
  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/amb/webhook"

	payload := strings.NewReader("{\n  \"business_id\": \"apple:com.acme.store\",\n  \"conversation_id\": \"conv-9f2e1c87\",\n  \"message_type\": \"text\",\n  \"text\": \"Where is my order?\",\n  \"received_at\": \"2026-08-23T14:05:00.000Z\"\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/amb/webhook")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"business_id\": \"apple:com.acme.store\",\n  \"conversation_id\": \"conv-9f2e1c87\",\n  \"message_type\": \"text\",\n  \"text\": \"Where is my order?\",\n  \"received_at\": \"2026-08-23T14:05:00.000Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/channels/amb/webhook")

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  \"business_id\": \"apple:com.acme.store\",\n  \"conversation_id\": \"conv-9f2e1c87\",\n  \"message_type\": \"text\",\n  \"text\": \"Where is my order?\",\n  \"received_at\": \"2026-08-23T14:05:00.000Z\"\n}"

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

{
  "data": {
    "accepted": true,
    "persisted": true,
    "message_id": "<string>"
  },
  "meta": {}
}

{
  "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-apple-signature

string

Legacy raw JWT (no Bearer prefix).

string

Apple message id header used as the persistence idempotency key when the body carries none.

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

Apple MSP webhook carrying one inbound message/event; authoring schema consumed by rawBody is a JSON string per the AMB MSP convention.

Response

Acknowledgement envelope. accepted lets Apple stop retrying; persisted / message_id denote whether the inbound message landed in the tenant inbox (false when only a typing indicator was received or persistence failed).

data

object

Acknowledgement fields: accepted lets Apple stop retrying; persisted / message_id denote whether the inbound message landed in the tenant inbox.

Show child attributes

API Reference

All Endpoints

Inbound Apple Messages for Business webhook

Authorizations

Headers

Body

Response