Webhook

This guide explains the structure of Webhook payloads and the types of events, such as Mailbox updates and Seed List changes, that trigger notifications in Warmy.io. Stay updated on key account changes with real-time alerts.

Our notification Webhooks request:

{
  "Content-Type": "application/json"
}

1. Mailbox resource

{
  "event_id": "UID string",
  "event_version": "string",
  "event_type": "string",
  "action_key": "string",
  "summary": "string",
  "affected_id": integer,
  "affected_type": "string",
  "data": {
    "id": integer,
    "email": "string",
    "domain": "string"
  },
  "date": "UTC DataTime in iso8601 format"
}

Example body for system mailbox events:

{
  "event_id": "75467eef-4561-4ea7-9475-9a51638a960b",
  "event_version": "1.0",
  "event_type": "MAILBOX::UPDATED",
  "action_key": "connection_failed",
  "summary": "Invalid credentials error",
  "affected_id": 10816,
  "affected_type": "mailbox",
  "data": {
    "id": 10816,
    "email": "a8516703@gmail.com",
    "domain": "gmail.com",
    "state": "blocked"
  },
  "date": "2025-06-11T10:07:26Z"
}

Webhook Fields Explained:

• event_id: event UID, 
• event_version: version of the event data,
• action_key:
  • connection_failed
  • sending_block
  • warmup_paused
  • warmup_send_fail
• summary: reason for some events 
• affected_type: event resource name (mailbox)  
• affected_id: resource id
• data: additional resource info
• date: UTC date in iso8601 format 
  
  

IMPLEMENTED: 

event_types list:
              MAILBOX::UPDATED

Possible Reasons for Mailbox Updates

• After receive exception by IMAP and disable use_imap
• Invalid credentials error
• After receive exception by IMAP and disable use_imap
• Please use the browser to login to your mailbox provider

2. Seed list resource

{
  "event_id": "UID string",
  "event_version": "string",
  "event_type": "string",
  "action_key": "string",
  "summary": "string",
  "affected_id": integer,
  "affected_type": "string",
  "data": {
    provider: "string",
    size: integet,
    created_at: "utc date in iso8601 format",
    refresh_date: "utc date in iso8601 format" 
  },
  "date": "UTC DataTime in iso8601 format"
}

Example body for system mailbox events:

{
  "event_id": "75467eef-4561-4ea7-9475-9a51638a960b",
  "event_version": "1.0",
  "event_type": "SEED_LIST::UPDATED",
  "action_key": "seed_list_update",
  "summary": "",
  "affected_id": 1000,
  "affected_type": "seed_list",
  "data": {
    provider: 'Gmail',
    size: 100,
    created_at: "2025-06-11T10:07:26Z",
    refresh_date: "2025-06-21T10:07:26Z"
  },
  "date": "2025-06-11T10:07:26Z"
}

Webhook Fields Explained:

• event_id: event UID, 
• event_version: version of the event data,
• action_key:
  • seed_list_update
  • seed_list_rotated

• affected_type: event resource name
• affected_id: resource id
• data: additional resource info
• date: UTC date in iso8601 format 

IMPLEMENTED: 

event_types list:
              SEED_LIST::ROTATE
              SEED_LIST::UPDATE

Seed List Rotation: Regularly replaces email addresses in the Seed List each month to ensure fresh recipients and avoid deliverability issues.
Seed List Update: Replaces inactive or blocked email addresses in the Seed List with valid ones as needed.