*************************************************************
``POST`` Add/Update Webhook Settings
*************************************************************

This API updates global AI interview webhook settings.

Request URL
============

.. code-block::

    POST /ai-interviews/settings/webhooks

Body Parameters
================

.. code-block:: json

    {
        "webhooks": {
            "start": {
                "status": true,
                "url": "https://example.com/webhook/start"
            },
            "submission": {
                "status": true,
                "url": "https://example.com/webhook/submission"
            },
            "auth": {
                "type": "basic",
                "basic": {
                    "username": "user",
                    "password": "pass"
                }
            }
        },
        "updateAll": true
    }

.. warning::

    Make sure to add your API key in the Header of the request using the key ``apiKey``.

Parameters
===========

+-------------------+------------+------------------------------------------------------------------------+
| Parameter         | Type       | Description                                                            |
+===================+============+========================================================================+
| updateAll         | boolean    | If true, updates all existing AI interviews with this webhook config.  |
+-------------------+------------+------------------------------------------------------------------------+
| start             | object     | Webhook configuration for when the candidate starts the interview.     |
+-------------------+------------+------------------------------------------------------------------------+
| submission        | object     | Webhook configuration for when the candidate submits the interview.    |
+-------------------+------------+------------------------------------------------------------------------+
| status            | boolean    | Whether the webhook is enabled.                                        |
+-------------------+------------+------------------------------------------------------------------------+
| url               | string     | The URL to receive event notifications.                                |
+-------------------+------------+------------------------------------------------------------------------+
| auth              | object     | Authentication configuration for webhooks (optional).                  |
+-------------------+------------+------------------------------------------------------------------------+
| auth.type         | string     | Authentication type: "basic" or "apikey".                              |
+-------------------+------------+------------------------------------------------------------------------+
| auth.basic        | object     | Basic authentication credentials (username and password).              |
+-------------------+------------+------------------------------------------------------------------------+
| auth.apikey       | object     | API key authentication (header name and API key value).                |
+-------------------+------------+------------------------------------------------------------------------+

.. note::

    - The ``start`` webhook is triggered when the candidate starts the AI interview.
    - The ``submission`` webhook is triggered when the candidate submits the AI interview.
    - Either one or both webhooks can be included in the request body.
    - If ``auth`` is included in the webhooks object, authentication settings will be updated. If ``auth`` is not included, existing authentication settings will be preserved.

Response
=========

.. code-block:: json

    {
        "webhooks": {
            "start": {
                "status": true,
                "url": "https://example.com/webhook/start"
            },
            "submission": {
                "status": true,
                "url": "https://example.com/webhook/submission"
            },
            "auth": {
                "type": "basic",
                "basic": {
                    "username": "user",
                    "password": null,
                    "hasPassword": true
                },
                "apikey": {
                    "header": null,
                    "apikey": null
                }
            }
        }
    }