Mailmus

Webhooks

Webhook Subscriptions Controller_list

GET
/apps/{appId}/webhooks

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/webhooks"
Empty

Webhook Subscriptions Controller_create

POST
/apps/{appId}/webhooks

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "https://yourapp.com/webhooks/mailmus",    "events": [      "email.sent",      "send.delivered"    ]  }'
Empty

Webhook Subscriptions Controller_update

PATCH
/apps/{appId}/webhooks/{id}

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/apps/string/webhooks/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Webhook Subscriptions Controller_remove

DELETE
/apps/{appId}/webhooks/{id}

Path Parameters

id*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/webhooks/string"
Empty

Webhook Subscriptions Controller_rotate Secret

POST
/apps/{appId}/webhooks/{id}/rotate-secret

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/webhooks/string/rotate-secret"
Empty

Webhook Subscriptions Controller_list Deliveries

GET
/apps/{appId}/webhooks/{id}/deliveries

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/webhooks/string/deliveries"
Empty

Webhook Subscriptions Controller_replay Delivery

POST
/apps/{appId}/webhooks/{id}/deliveries/{deliveryId}/replay

Path Parameters

id*string
deliveryId*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/webhooks/string/deliveries/string/replay"
Empty

Webhook Subscriptions Controller_test

POST
/apps/{appId}/webhooks/{id}/test

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/webhooks/string/test"
Empty