Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion specs/email-sending.openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ tags:
x-page-description: Manage webhook endpoints
description: |
Configure webhooks to receive real-time notifications about events in
your Mailtrap account. For a complete guide, see
your Mailtrap account. For a complete guide, see
[Webhooks](https://docs.mailtrap.io/email-api-smtp/advanced/webhooks).
paths:
/api/accounts/{account_id}/sending_domains:
Expand Down Expand Up @@ -1619,6 +1619,7 @@ paths:
- email_sending
- campaigns
- audit_log
- inbound_receiving
example: email_sending
active:
type: boolean
Expand Down Expand Up @@ -1667,6 +1668,13 @@ paths:
domains if omitted. Applicable only for `email_sending`
and `campaigns` webhooks.
example: 435
inbound_inbox_id:
type: integer
description: |
ID of the inbound inbox the webhook is linked to.
Required for `inbound_receiving` webhooks; must not be
set for any other webhook type.
example: 1
responses:
'200':
description: Webhook created successfully
Expand Down Expand Up @@ -1856,6 +1864,12 @@ paths:
- delivery
- bounce
- unsubscribe
inbound_inbox_id:
type: integer
description: |
ID of the inbound inbox the webhook is linked to.
Applicable only for `inbound_receiving` webhooks.
example: 1
responses:
'200':
description: Webhook updated successfully
Expand Down Expand Up @@ -2458,6 +2472,7 @@ components:
- email_sending
- campaigns
- audit_log
- inbound_receiving
example: email_sending
payload_format:
type: string
Expand Down Expand Up @@ -2486,6 +2501,14 @@ components:
omitted. Applicable only for `email_sending` and `campaigns`
webhooks.
example: 435
inbound_inbox_id:
type:
- integer
- 'null'
description: |
ID of the inbound inbox the webhook is linked to. Applicable only
for `inbound_receiving` webhooks.
example: 1
event_types:
type: array
description: |
Expand Down
Loading
Loading