Email settings

Events

Action Event name
create an email setting (POST /email-settings) emailSetting.created
update an email setting (PUT /email-settings/:email) emailSetting.updated
delete an email setting (DELETE /email-settings/:email) emailSetting.deleted

Payload example created

{
  "attemptId": "e046a427-3e6f-4bdc-9769-075f08476340",
  "created": 1635362808,
  "data": {
    "active": false,
    "createdAt": {
      "offset": 0,
      "value": "2021-10-27T19:26:18.611Z"
    },
    "createdBy": "60afebc09733b43ed1cf5165",
    "dkim": {
      "dkimTokens": [
        "fym236ukyujchoyu4v3vzetr7kghe6wf",
        "abixtuckkxuc7ypv4g7foltwiz4mecpp",
        "vmx7inernw5jgxfp2hkmvuth63cuifmx"
      ],
      "requestId": "9db45f43-8ae9-4898-91a5-35b6a7df6e62"
    },
    "dkimverified": false,
    "email": "two@mail.com",
    "name": "Two",
    "updatedAt": {
      "offset": 0,
      "value": "2021-10-27T19:26:18.611Z"
    },
    "updatedBy": "60afebc05745b43ed1cf5165",
    "verified": false
  },
  "event": "emailSetting.created",
  "id": "de6aae0d-3a09-4fe5-aba9-d6c29cd66715",
  "livemode": false
}

Payload fields (emailSetting.created)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created int Unix timestamp when the event was created
event string emailSetting.created
livemode boolean Whether the account is in live mode
data object The created email setting document (email, name, active, verified, dkimverified, dkim, createdBy, updatedBy, createdAt, updatedAt)

Payload example updated

{
  "attemptId": "2ab8f6b6-58f5-4075-b236-b9ea9f6d0557",
  "created": 1635433040,
  "data": {
    "active": false,
    "createdAt": {
      "offset": 0,
      "value": "2021-10-28T14:49:30.219Z"
    },
    "createdBy": "60afebc09745b43ed1cf5165",
    "dkim": {
      "dkimTokens": [
        "fym236ukyujchoyu4v3vzetr7kghe6wf",
        "abixtuckkxuc7ypv4g7foltwiz4mecpp",
        "vmx7inernw5jgxfp2hkmvuth63cuifmx"
      ],
      "requestId": "8155de4d-0d16-4ab2-9f0b-bb03bab24262"
    },
    "dkimverified": false,
    "email": "four@mail.com",
    "name": "NameFour",
    "updatedAt": {
      "offset": 0,
      "value": "2021-10-28T14:56:09.013Z"
    },
    "updatedBy": "60afebc09745b43er1cf5165",
    "verified": false
  },
  "event": "emailSetting.updated",
  "id": "bbf4755c-6096-4a48-8e7f-e508355804a28",
  "livemode": false
}

Payload fields (emailSetting.updated)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created int Unix timestamp when the event was created
event string emailSetting.updated
livemode boolean Whether the account is in live mode
data object The updated email setting document (email, name, active, verified, dkimverified, dkim, createdBy, updatedBy, createdAt, updatedAt)

Payload example deleted

{
  "attemptId": "f975b608-235a-4c25-94f8-ebde7f6b64e3",
  "created": 1635362810,
  "data": {
    "emailSetting": {
      "active": false,
      "createdAt": {
        "offset": 0,
        "value": "2021-10-27T19:26:18.611Z"
      },
      "createdBy": "60afebc04445b43ed1cf5165",
      "dkim": {
        "dkimTokens": [
          "fym236ukyujchoyu4v3vzetr7kghe6wf",
          "abixtuckkxuc7ypv4g7foltwiz4mecpp",
          "vmx7inernw5jgxfp2hkmvuth63cuifmx"
        ],
        "requestId": "9db45f43-8ae9-4898-91a5-35b6a7df6e62"
      },
      "dkimverified": false,
      "email": "two@mail.com",
      "name": "Two",
      "updatedAt": {
        "offset": 0,
        "value": "2021-10-27T19:26:18.611Z"
      },
      "updatedBy": "60afegg09745b43ed1cf5165",
      "verified": false
    }
  },
  "event": "emailSetting.deleted",
  "id": "4ffc1fac-7c2c-4422-b009-369b24d4dd0f",
  "livemode": false
}

Payload fields (emailSetting.deleted)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created int Unix timestamp when the event was created
event string emailSetting.deleted
livemode boolean Whether the account is in live mode
data.emailSetting object The deleted email setting document (email, name, active, verified, dkimverified, dkim, createdBy, updatedBy, createdAt, updatedAt)