|
5827 | 5827 | "description": "Webhook description, shown in the UI", |
5828 | 5828 | "example": "Sends critical alerts to the #incidents channel" |
5829 | 5829 | }, |
| 5830 | + "titleEmoji": { |
| 5831 | + "type": "boolean", |
| 5832 | + "description": "Set to false to omit the state emoji prefix from notification titles sent through this webhook. Unset or true keeps the default prefix.", |
| 5833 | + "example": false |
| 5834 | + }, |
5830 | 5835 | "updatedAt": { |
5831 | 5836 | "type": "string", |
5832 | 5837 | "format": "date-time", |
|
5879 | 5884 | "description": "Webhook description, shown in the UI", |
5880 | 5885 | "example": "Routes alerts to incident.io for on-call escalation" |
5881 | 5886 | }, |
| 5887 | + "titleEmoji": { |
| 5888 | + "type": "boolean", |
| 5889 | + "description": "Set to false to omit the state emoji prefix from notification titles sent through this webhook. Unset or true keeps the default prefix.", |
| 5890 | + "example": false |
| 5891 | + }, |
5882 | 5892 | "updatedAt": { |
5883 | 5893 | "type": "string", |
5884 | 5894 | "format": "date-time", |
|
5931 | 5941 | "description": "Webhook description, shown in the UI", |
5932 | 5942 | "example": "Forwards alert payloads to an external monitoring service" |
5933 | 5943 | }, |
| 5944 | + "titleEmoji": { |
| 5945 | + "type": "boolean", |
| 5946 | + "description": "Set to false to omit the state emoji prefix from notification titles sent through this webhook. Unset or true keeps the default prefix.", |
| 5947 | + "example": false |
| 5948 | + }, |
5934 | 5949 | "body": { |
5935 | 5950 | "type": "string", |
5936 | 5951 | "description": "Optional request body template", |
|
6023 | 6038 | "service", |
6024 | 6039 | "url" |
6025 | 6040 | ], |
6026 | | - "description": "Webhook create/update body. `body`, `headers`, and `queryParams`\nonly take effect for services that issue a templated HTTP request\n(`generic`, `incidentio`). The `slack` service posts a fixed payload\nto its incoming-webhook URL and ignores them, so supplying any of\nthese fields on a `slack` webhook is rejected. `headers` and\n`queryParams` are write-only — they are accepted here but never\nreturned by any read endpoint, so secrets such as auth tokens do\nnot leak. On\nupdate (PUT), omitted readable fields (`description`, `body`) are\ncleared, while omitted `headers`/`queryParams` are preserved —\nsend an explicit `{}` to clear them. Exception: if the destination\n(`url` or `service`) changes, omitted `headers`/`queryParams` are\ncleared rather than preserved, so stored secrets are never forwarded\nto a new destination; re-supply them for the new destination.\n", |
| 6041 | + "description": "Webhook create/update body. `body`, `headers`, and `queryParams`\nonly take effect for services that issue a templated HTTP request\n(`generic`, `incidentio`). The `slack` service posts a fixed payload\nto its incoming-webhook URL and ignores them, so supplying any of\nthese fields on a `slack` webhook is rejected. `headers` and\n`queryParams` are write-only — they are accepted here but never\nreturned by any read endpoint, so secrets such as auth tokens do\nnot leak. On\nupdate (PUT), omitted readable fields (`description`, `titleEmoji`, `body`) are\ncleared, while omitted `headers`/`queryParams` are preserved —\nsend an explicit `{}` to clear them. Exception: if the destination\n(`url` or `service`) changes, omitted `headers`/`queryParams` are\ncleared rather than preserved, so stored secrets are never forwarded\nto a new destination; re-supply them for the new destination.\n", |
6027 | 6042 | "properties": { |
6028 | 6043 | "name": { |
6029 | 6044 | "type": "string", |
|
6054 | 6069 | "description": "Webhook description, shown in the UI.", |
6055 | 6070 | "example": "Sends critical alerts to the #incidents channel" |
6056 | 6071 | }, |
| 6072 | + "titleEmoji": { |
| 6073 | + "type": "boolean", |
| 6074 | + "description": "Set to false to omit the state emoji prefix from notification titles sent through this webhook. Unset or true keeps the default prefix.", |
| 6075 | + "example": false |
| 6076 | + }, |
6057 | 6077 | "body": { |
6058 | 6078 | "type": "string", |
6059 | 6079 | "maxLength": 16384, |
|
9178 | 9198 | "/api/v2/webhooks/{id}": { |
9179 | 9199 | "put": { |
9180 | 9200 | "summary": "Update Webhook", |
9181 | | - "description": "Replaces an existing webhook. Readable optional fields\n(`description`, `body`) are a full replace: omitting them clears\nthem. The write-only fields `headers` and `queryParams` are never\nreturned on read, so omitting them preserves the stored values;\nsend an explicit empty object (`{}`) to clear them. Exception: if the\ndestination (`url` or `service`) changes, omitted `headers`/\n`queryParams` are cleared rather than preserved so stored secrets are\nnever forwarded to a new destination.\n", |
| 9201 | + "description": "Replaces an existing webhook. Readable optional fields\n(`description`, `titleEmoji`, `body`) are a full replace: omitting them clears\nthem. The write-only fields `headers` and `queryParams` are never\nreturned on read, so omitting them preserves the stored values;\nsend an explicit empty object (`{}`) to clear them. Exception: if the\ndestination (`url` or `service`) changes, omitted `headers`/\n`queryParams` are cleared rather than preserved so stored secrets are\nnever forwarded to a new destination.\n", |
9182 | 9202 | "operationId": "updateWebhook", |
9183 | 9203 | "tags": [ |
9184 | 9204 | "Webhooks" |
|
0 commit comments