hookdeck/openapi/hookdeck-notifications-api-openapi.yml at main · api-evangelist/hookdeck · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
openapi: 3.0.1
info:
  title: Hookdeck Bookmarks Attempts Notifications API
  version: 1.0.0
  description: Save bookmarked events for quick replay and convenient one-click testing during development.
  contact:
    name: Hookdeck Support
    url: https://hookdeck.com/contact-us
    email: info@hookdeck.com
servers:
- url: https://api.hookdeck.com/2025-07-01
  description: Production API
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Notifications
  description: Notifications let your team receive alerts anytime an issue changes.
paths:
  /notifications/webhooks:
    put:
      operationId: toggleWebhookNotifications
      summary: Webhook Notifications
      description: This endpoint enables or disables webhook notifications for the project, and sets the topics and source to deliver them to.
      tags:
      - Notifications
      responses:
        '200':
          description: Toggle operation status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToggleWebhookNotifications'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  type: boolean
                  description: Enable or disable webhook notifications on the project
                topics:
                  type: array
                  items:
                    $ref: '#/components/schemas/TopicsValue'
                  description: List of topics to send notifications for
                source_id:
                  type: string
                  description: The Hookdeck Source to send the webhook to
              required:
              - enabled
              - topics
              - source_id
              additionalProperties: false
  /teams/current/custom_domains:
    post:
      operationId: addCustomDomain
      summary: Add a custom domain to the project
      description: ''
      tags:
      - Notifications
      responses:
        '200':
          description: Custom domain successfuly added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCustomHostname'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCustomHostname'
    get:
      operationId: listCustomDomains
      summary: List all custom domains and their verification statuses for the project
      description: ''
      tags:
      - Notifications
      responses:
        '200':
          description: List of custom domains
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomDomainSchema'
      parameters: []
  /teams/current/custom_domains/{domain_id}:
    delete:
      operationId: deleteCustomDomain
      summary: Removes a custom domain from the project
      description: ''
      tags:
      - Notifications
      responses:
        '200':
          description: Custom domain successfuly removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCustomDomainSchema'
      parameters:
      - in: path
        name: domain_id
        schema:
          type: string
        required: true
components:
  schemas:
    ToggleWebhookNotifications:
      type: object
      properties:
        enabled:
          type: boolean
        topics:
          type: array
          items:
            $ref: '#/components/schemas/TopicsValue'
          nullable: true
        source_id:
          type: string
      required:
      - enabled
      - source_id
      additionalProperties: false
    DeleteCustomDomainSchema:
      type: object
      properties:
        id:
          type: string
          description: The custom hostname ID
      required:
      - id
      additionalProperties: false
    AddCustomHostname:
      type: object
      properties:
        hostname:
          type: string
          description: The custom hostname to attach to the project
      required:
      - hostname
      additionalProperties: false
    TopicsValue:
      type: string
      enum:
      - issue.opened
      - issue.updated
      - deprecated.attempt-failed
      - event.successful
      description: Supported topics
      x-docs-type: string
    ListCustomDomainSchema:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
          hostname:
            type: string
          status:
            type: string
          ssl:
            type: object
            properties:
              id:
                type: string
              type:
                type: string
              method:
                type: string
              status:
                type: string
              txt_name:
                type: string
              txt_value:
                type: string
              validation_records:
                type: array
                items:
                  type: object
                  properties:
                    status:
                      type: string
                    txt_name:
                      type: string
                    txt_value:
                      type: string
                  additionalProperties: false
              dcv_delegation_records:
                type: array
                items:
                  type: object
                  properties:
                    cname:
                      type: string
                    cname_target:
                      type: string
                  additionalProperties: false
              settings:
                type: object
                properties:
                  min_tls_version:
                    type: string
                additionalProperties: false
              bundle_method:
                type: string
              wildcard:
                type: boolean
              certificate_authority:
                type: string
            additionalProperties: false
          verification_errors:
            type: array
            items:
              type: string
          ownership_verification:
            type: object
            properties:
              type:
                type: string
              name:
                type: string
              value:
                type: string
            additionalProperties: false
          created_at:
            type: string
        additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    basicAuth:
      type: http
      scheme: basic