PUT /api/v1/projects/:project_id/web_hook
Creates or updates the web hook for a project

Creates a new web hook configuration for a project or updates the existing configuration.

Examples

Example Response:
{
    "status": "success",
    "message": "success",
    "result": {
        "client_id": 19817472,
        "project_id": 1249918,
        "endpoint": "example.com/web_hook",
        "enable_http_authorization": false,
        "enable_web_hook": true,
        "customer_parameters": {
          "key 1": "value 1",
          "key 2": "value 2",
          "key 3": "value 3",
        }
    }
}

Params

Param name Description
project_id
required

The ID of the project.

Validations:

  • Must be a Integer
endpoint
optional

The URL to execute when this web hook is triggered. The HTTPS protocol is automatically enforced to increase security and the endpoint URL should not contain the protocol.

Validations:

  • Must be a String
enable_web_hook
optional

Enables or disables the web hook. Can be “true” (enabled) or “false” (disabled).

Validations:

  • Must be a String
enable_http_authorization
optional

Enables or disables using HTTP Authorization header with the web hook. Can be “true” (enabled) or “false” (disabled).

Validations:

  • Must be a String
http_authorization_value
optional

The value to be added to the HTTP Authorization header when the web hook is executed. This value cannot be retrieved once set. This value can be set to basic authentication, token authentication or other HTTP Authorization values in order to authorize the web hook event for the executed endpoint.

Validations:

  • Must be a String
custom_parameters
optional

A dictionary of key-pair values that will be added to the web hook POST request.

Validations:

  • Must be a Hash