senlin/api-ref/source/webhooks.inc
liyi 0cbd575aa0 Update events and actions API doc
Change-Id: I598de366a1cc411c40f9f03f740bca6b6dbe4aeb
2017-07-20 18:01:51 +08:00

51 lines
879 B
HTML

===================
Webhooks (webhooks)
===================
Triggers an action represented by a webhook.
Trigger webhook action
======================
.. rest_method:: POST /v1/webhooks/{webhook_id}/trigger
Triggers a webhook receiver.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 202
.. rest_status_code:: error status.yaml
- 403
- 404
- 503
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- webhook_id: webhook_id_url
- V: webhook_version
- params: webhook_params
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- Location: location
- action: action_action
Response Example
----------------
.. literalinclude:: samples/webhook-action-response.json
:language: javascript