Properties
| Name | Type | Description |
|---|---|---|
| webhook | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/createWebhookRequest",
"title": "Create Webhook Request Body",
"type": "object",
"properties": {
"webhook": {
"type": "object",
"required": [
"name",
"collection"
],
"properties": {
"collection": {
"type": "string",
"format": "uid",
"description": "The unique ID of the collection to trigger when calling this webhook.",
"example": "12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2"
},
"environment": {
"type": "string",
"format": "uid",
"description": "The unique ID of the environment to trigger when calling this webhook.",
"example": "12345678-d9c7dc8f-904e-4bba-99b5-4d490aae1957"
},
"name": {
"type": "string",
"description": "The webhook's name. On success, the system creates a new monitor with this name in the **Monitors** tab.",
"example": "Test Webhook"
}
}
}
}
}