Create or Update Webhook Configuration
Create/update webhook configuration
Create or update your webhook configuration to use the webhook feature
PUT http://api.cmtelecom.com/bulkemail/v1.0/accounts/{accountID}/webhooks
PUT Parameters
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
AccountID | Path | The account guid | True | Guid | A8C062E4-ECFD-48D0-89B1-A37D2622B7A9 |
Body | Body | The new webhook configuration | True | Json object | See example request |
X-CM-PRODUCTTOKEN | Header | Your product token | True | Guid | C24A5029-37DD-4161-9728-F80D8639588E |
{
"Url": "https://cm.com",
"Settings": {
"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
}
}
Responses
Http status | Description |
---|---|
200 | Webhook configured |
400 | Bad request |
{
"AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
"Url": "https://cm.com",
"Settings": {
"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
},
"CreatedOn": "2019-02-01T14:07:15.423",
"CreatedOnUtc": "2019-02-01T13:07:15.423Z",
"ModifiedOn": "2019-02-01T14:07:15.423",
"ModifiedOnUtc": "2019-02-01T13:07:15.423Z",
"DeletedOn": null,
"DeletedOnUtc": null
}
Updated about 2 years ago