Create a webhook

POST 
/webhook

Create a webhook associated with a project to receive notifications.

Request

Details

Query Parameters

apiKey stringrequired

The public API key for authentication.

Details

Header Parameters

API-SECRET stringrequired

The secret API key for authentication.

application/json

Details

Body

required

projectId string
webhookUrl string
eventType string

Responses

201

Webhook successfully created.

application/json

Schema

Details

Schema

projectId string
webhookUrl string
eventType string

Example (from schema)

{
  "projectId": "string",
  "webhookUrl": "string",
  "eventType": "string"
}

403

Access to the resource is forbidden.

application/json

Schema

Details

Schema

statusCode integer
Example: 403
errorMessage string
Example: Forbidden resource
error string
Example: Forbidden

Example (from schema)

{
  "statusCode": 403,
  "errorMessage": "Forbidden resource",
  "error": "Forbidden"
}

Loading...