POST
/
projects
/
{project_id}
/
webhook
curl --request POST \
  --url https://api.gan.ai/projects/{project_id}/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enable": true,
  "url": "<string>",
  "Authorization": "Bearer <Insert_the_token_here>"
}'
{
  "enable": true,
  "url": "<string>",
  "Authorization": "Bearer <Insert_the_token_here>",
  "user_identifier": "<string>",
  "user_password": "<string>",
  "message": "<string>",
  "send_query_params": true,
  "send_replacement": true,
  "serialize_payload": true,
  "tags_mapping": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

project_id
string
required

The project_id for which the webhook needs to be set.

Body

application/json

This value corresponds to the webhook configured with this particular project.

enable
boolean
default:true
required
url
string
required

The url of your webhook.

Authorization
string
default:Bearer <Insert_the_token_here>

The token must follow the bearer format.

Response

200
application/json
Successful Response

This value corresponds to the webhook configured with this particular project.

enable
boolean
default:true
required
url
string
required

The url of your webhook.

user_identifier
string
required
user_password
string
required
message
string
required
send_query_params
boolean
required
send_replacement
boolean
required
serialize_payload
boolean
required
tags_mapping
object
required
Authorization
string
default:Bearer <Insert_the_token_here>

The token must follow the bearer format.