Client API: Mail: Webhooks
The 3 Client API operations for webhooks.
Part of Mail.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/smtp-relay/{service_id}/webhooks |
List webhooks |
| POST | /api/v1/client/smtp-relay/{service_id}/webhooks |
Create webhook |
| DELETE | /api/v1/client/smtp-relay/{service_id}/webhooks/{webhook_id} |
Delete webhook |
List webhooks
Section titled List webhooksGET /api/v1/client/smtp-relay/{service_id}/webhooks
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Create webhook
Section titled Create webhookPOST /api/v1/client/smtp-relay/{service_id}/webhooks
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
service_id |
path | integer | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
url |
string | yes |
events |
array of string | no |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Delete webhook
Section titled Delete webhookDELETE /api/v1/client/smtp-relay/{service_id}/webhooks/{webhook_id}
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
webhook_id |
path | integer | yes |
service_id |
path | integer | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |