REST API for Webhook

API Logs

Every API call is logged under Settings > Technical > API Configuration > API Logs. Each log record shows:

• Request Preview / Response Preview - first N characters of the payload
• Request Size / Response Size - total character count
• Full Log button - opens the full JSON attachment when payload exceeds the preview limit
• Callback URL - URL stored from the inbound request for later outbound push

Authentication

Authenticate via /web/session/authenticate before calling any route:

{
  "jsonrpc": "2.0",
  "method": "call",
  "params": {
    "db": "<db_name>",
    "login": "<username>",
    "password": "<password>"
  }
}

Alternative - API Key: send Authorization: Bearer <api_key> on every request. No session call needed.

Relational Field Format

Multiple many2many items sharing the same lookup field are batched into a single DB query.

API Routes

{
  "params": {
    "model": "<model name>",
    "vals": {
      "callback_url": "https://your-system/webhook",
      "payload": {
        "<field1>": "<value1>",
        "<many2one_field_id>": {"name": "<value>"},
        "<many2many_field_ids>": {"mode": "replace", "records": [{"name": "<val1>"}]},
        "<one2many_field_ids>": [
          {"<field>": "<value>", "<nested_m2o_id>": {"name": "<value>"}}
        ]
      },
      "auto_create": {
        "<many2one_field_id>": {"name": "<value>"}
      },
      "result_field": ["<field1>"]
    }
  }
}

{
  "params": {
    "model": "<model name>",
    "vals": {
      "search_key": {"<key_field>": "<value>"},
      "payload": {
        "<field1>": "<value1>",
        "<many2one_field_id>": {"name": "<value>"}
      },
      "result_field": ["<field1>"]
    }
  }
}

{
  "params": {
    "model": "<model name>",
    "vals": {
      "search_key": {"<key_field>": "<value>"},
      "payload": {
        "<field1>": "<value1>",
        "<many2one_field_id>": {"id": 5},
        "<many2many_field_ids>": {"mode": "add", "records": [{"name": "<val1>"}]}
      },
      "result_field": ["<field1>"]
    }
  }
}

{
  "params": {
    "model": "<model name>",
    "vals": {
      "payload": {
        "search_field": [
          "<field1>",
          "<m2o_field>{<subfield1>,<subfield2>}",
          "<o2m_field>{<subfield1>}"
        ],
        "search_domain": "[('<field>', '<operator>', '<value>')]",
        "limit": 10,
        "order": "<field1> asc, <field2> desc"
      }
    }
  }
}

{
  "params": {
    "model": "account.move",
    "vals": {
      "search_key": {"id": 26},
      "payload": {
        "method": "action_post",
        "context": {"lang": "th_TH"}
      }
    }
  }
}

Attaching Files

Add attachment_ids at any payload level:

"attachment_ids": [{"name": "<filename>", "datas": "<base64>"}]

Step 1 - Add mixin to the target model

In any private addon, add one _inherit line:

from odoo import models

class SaleOrder(models.Model):
    _name = "sale.order"
    _inherit = ["sale.order", "webhook.outbound.mixin"]

All outbound behaviour is driven by rules configured in the UI.

Step 2 - Configure an Outbound Webhook Rule

Go to Settings > Technical > API Configuration > Outbound Webhook Rules. See CONFIGURE.md for the full field reference.

Trigger domain examples:

# Simple
[("state", "=", "sale")]

# Multiple conditions
[("state", "=", "done"), ("amount_total", ">", 100)]

# Multiple accepted values
[("state", "in", ["done", "validated"])]

The webhook fires only when a field in the domain is being written and the record matches the full domain after the write. This prevents re-triggering when unrelated fields are edited on an already-matching record.

Payload Fields - relational expansion

Use field{sub1,sub2} syntax (same as search_data) to expand relational fields:

["name", "state", "currency_id{id,name,code}", "order_line{product_id,qty_done,price_unit}"]

Result posted to the external system:

{
  "name": "SO001",
  "state": "sale",
  "currency_id": [{"id": 3, "name": "Thai Baht", "code": "THB"}],
  "order_line": [
    {"product_id": 5, "qty_done": 2.0, "price_unit": 500.0}
  ]
}

many2one fields expand to a list with one item (consistent with search_data behaviour).

Per-record Callback URL

Pass callback_url in the inbound create_data request. Odoo stores it linked to the created record. When the outbound rule fires with Endpoint Source = Record Callback URL, the system looks up that URL and POSTs to it.

{
  "params": {
    "model": "sale.order",
    "vals": {
      "callback_url": "https://ext-system/webhook/so-status",
      "payload": {
        "partner_id": {"name": "ABC Co."},
        "order_line": [{"product_id": {"name": "Product A"}, "product_uom_qty": 1}]
      }
    }
  }
}

When the SO is confirmed → Odoo automatically POSTs to https://ext-system/webhook/so-status.

Outbound Logs

All outbound calls appear in API Logs with Log Type = Send. Failed calls are marked state = failed with the error in the response preview.