Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orderprotection.com/llms.txt

Use this file to discover all available pages before exploring further.

{
  "id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
  "topic": "protection.added",
  "created_at": "2024-03-20T10:00:00Z",
  "body": {
    "order_id": "order-1",
    "source_order_id": "100",
    "amount": 5.99,
    "currency": "USD"
  }
}
This webhook is triggered when protection has been manually added to an order through the Order Protection dashboard. The amount in the webhook payload represents the total charge to be billed to the customer.

​
Request Body

The webhook will send a JSON payload with the following structure:

​
Properties

​
id
string
Unique identifier for the webhook event
​
topic
string
The webhook topic
​
created_at
string
ISO 8601 timestamp of when the webhook was created
​
body
object
The webhook payload