Skip to content

[18.0][FIX] usability_webhooks: readme #279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Saran440 merged 1 commit into from
Mar 11, 2026
Merged

[18.0][FIX] usability_webhooks: readme #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions usability_webhooks/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"payload": {
"field1": "value1",
"<field1>": "<value1>",
...
},
"result_field": ["field1", ...] # optional
"result_field": ["<field1>", ...] # optional
}
}
}
Expand All @@ -100,13 +100,13 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"search_key": {
"<key_field>": "value", # can be ID or name search string
"<key_field>": "<value>", # can be ID or name search string
},
"payload": {
"field1": "value1",
"<field1>": "<value1>",
...
},
"result_field": ["field1", ...] # optional
"result_field": ["<field1>", ...] # optional
}
}
}
Expand All @@ -121,12 +121,13 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"search_key": {
"<key_field>": "value", # can be ID or name search string
"<key_field>": "<value>", # can be ID or name search string
},
"payload": {
"field1": "value1",
"<field1>": "<value1>",
...
}
},
"result_field": ["<field1>", ...] # optional
}
}
}
Expand All @@ -141,10 +142,10 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"payload": {
"search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...],
"search_domain": "[('field', 'operator', 'value')]",
"search_field": ["<field1>", "<field2>", "<field3>{<subfield1>, <subfield2>}", ...],
"search_domain": "[('<field>', '<operator>', '<value>')]",
"limit": 1,
"order": "field1 , field2 desc, ..."
"order": "<field1> , <field2> desc, ..."
}
}
}
Expand All @@ -164,7 +165,7 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"search_key": {
"<key_field>": "value", # can be ID or name search string
"<key_field>": "<value>", # can be ID or name search string
},
"payload": {
"method": "<method>",
Expand Down
25 changes: 13 additions & 12 deletions usability_webhooks/readme/USAGE.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"payload": {
"field1": "value1",
"<field1>": "<value1>",
...
},
"result_field": ["field1", ...] # optional
"result_field": ["<field1>", ...] # optional
}
}
}
Expand All @@ -60,13 +60,13 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"search_key": {
"<key_field>": "value", # can be ID or name search string
"<key_field>": "<value>", # can be ID or name search string
},
"payload": {
"field1": "value1",
"<field1>": "<value1>",
...
},
"result_field": ["field1", ...] # optional
"result_field": ["<field1>", ...] # optional
}
}
}
Expand All @@ -81,12 +81,13 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"search_key": {
"<key_field>": "value", # can be ID or name search string
"<key_field>": "<value>", # can be ID or name search string
},
"payload": {
"field1": "value1",
"<field1>": "<value1>",
...
}
},
"result_field": ["<field1>", ...] # optional
}
}
}
Expand All @@ -101,10 +102,10 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"payload": {
"search_field": ["field1", "field2", "field3{subfield1, subfield2}", ...],
"search_domain": "[('field', 'operator', 'value')]",
"search_field": ["<field1>", "<field2>", "<field3>{<subfield1>, <subfield2>}", ...],
"search_domain": "[('<field>', '<operator>', '<value>')]",
"limit": 1,
"order": "field1 , field2 desc, ..."
"order": "<field1> , <field2> desc, ..."
}
}
}
Expand All @@ -124,7 +125,7 @@ Following successful authentication, you can proceed with 5 API routes:
"model": "<model name>",
"vals": {
"search_key": {
"<key_field>": "value", # can be ID or name search string
"<key_field>": "<value>", # can be ID or name search string
},
"payload": {
"method": "<method>",
Expand Down
25 changes: 13 additions & 12 deletions usability_webhooks/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,10 +424,10 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
</span> <span class="s2">&quot;model&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;vals&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;payload&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;field1&quot;</span><span class="p">:</span> <span class="s2">&quot;value1&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;value1&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="o">...</span><span class="w">
</span> <span class="p">},</span><span class="w">
</span> <span class="s2">&quot;result_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;field1&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="c1"># optional</span><span class="w">
</span> <span class="s2">&quot;result_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="c1"># optional</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span><span class="p">}</span>
Expand All @@ -442,13 +442,13 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
</span> <span class="s2">&quot;model&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;vals&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;search_key&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;&lt;key_field&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;value&quot;</span><span class="p">,</span> <span class="c1"># can be ID or name search string</span><span class="w">
</span> <span class="s2">&quot;&lt;key_field&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;value&gt;&quot;</span><span class="p">,</span> <span class="c1"># can be ID or name search string</span><span class="w">
</span> <span class="p">},</span><span class="w">
</span> <span class="s2">&quot;payload&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;field1&quot;</span><span class="p">:</span> <span class="s2">&quot;value1&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;value1&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="o">...</span><span class="w">
</span> <span class="p">},</span><span class="w">
</span> <span class="s2">&quot;result_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;field1&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="c1"># optional</span><span class="w">
</span> <span class="s2">&quot;result_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="c1"># optional</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span><span class="p">}</span>
Expand All @@ -462,12 +462,13 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
</span> <span class="s2">&quot;model&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;vals&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;search_key&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;&lt;key_field&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;value&quot;</span><span class="p">,</span> <span class="c1"># can be ID or name search string</span><span class="w">
</span> <span class="s2">&quot;&lt;key_field&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;value&gt;&quot;</span><span class="p">,</span> <span class="c1"># can be ID or name search string</span><span class="w">
</span> <span class="p">},</span><span class="w">
</span> <span class="s2">&quot;payload&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;field1&quot;</span><span class="p">:</span> <span class="s2">&quot;value1&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;value1&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="o">...</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="p">},</span><span class="w">
</span> <span class="s2">&quot;result_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="c1"># optional</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span><span class="p">}</span>
Expand All @@ -481,10 +482,10 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
</span> <span class="s2">&quot;model&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;vals&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;payload&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;search_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;field1&quot;</span><span class="p">,</span> <span class="s2">&quot;field2&quot;</span><span class="p">,</span> <span class="s2">&quot;field3{subfield1, subfield2}&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span><span class="w">
</span> <span class="s2">&quot;search_domain&quot;</span><span class="p">:</span> <span class="s2">&quot;[('field', 'operator', 'value')]&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;search_field&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;&lt;field1&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;&lt;field2&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;&lt;field3&gt;{&lt;subfield1&gt;, &lt;subfield2&gt;}&quot;</span><span class="p">,</span> <span class="o">...</span><span class="p">],</span><span class="w">
</span> <span class="s2">&quot;search_domain&quot;</span><span class="p">:</span> <span class="s2">&quot;[('&lt;field&gt;', '&lt;operator&gt;', '&lt;value&gt;')]&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;order&quot;</span><span class="p">:</span> <span class="s2">&quot;field1 , field2 desc, ...&quot;</span><span class="w">
</span> <span class="s2">&quot;order&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;field1&gt; , &lt;field2&gt; desc, ...&quot;</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="p">}</span><span class="w">
</span> <span class="p">}</span><span class="w">
Expand All @@ -507,7 +508,7 @@ <h1><a class="toc-backref" href="#toc-entry-1">Usage</a></h1>
</span> <span class="s2">&quot;model&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;model name&gt;&quot;</span><span class="p">,</span><span class="w">
</span> <span class="s2">&quot;vals&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;search_key&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;&lt;key_field&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;value&quot;</span><span class="p">,</span> <span class="c1"># can be ID or name search string</span><span class="w">
</span> <span class="s2">&quot;&lt;key_field&gt;&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;value&gt;&quot;</span><span class="p">,</span> <span class="c1"># can be ID or name search string</span><span class="w">
</span> <span class="p">},</span><span class="w">
</span> <span class="s2">&quot;payload&quot;</span><span class="p">:</span> <span class="p">{</span><span class="w">
</span> <span class="s2">&quot;method&quot;</span><span class="p">:</span> <span class="s2">&quot;&lt;method&gt;&quot;</span><span class="p">,</span><span class="w">
Expand Down