Step Contacts

Events that fire when a contact progresses through a sequence step.

Events that fire when a contact progresses through a sequence step.

Events

EventWhen it fires
step_contact.createdA contact is enrolled into a sequence step.
step_contact.updatedA step contact record is updated (status, timing, and similar fields).

Examples

Each example is the full POST body Whippy sends, including the envelope fields data, api_version, event, created_at, and request_id.

step_contact.created

A contact is enrolled into a sequence step.

{
  "data": {
    "id": "8276e83f-21b1-4f16-b3a3-1a1a7c8e46f1",
    "status": "active",
    "contact": {
      "id": "147363b7-3ce5-445f-9193-27e96f1cf12d",
      "name": "Giovanni Torp",
      "email": null,
      "phone": "+13603094336"
    },
    "step_id": "5137e2c4-fe04-4c55-8810-943b33fd0f72",
    "channel_id": "70c9cc95-e78b-4acf-9079-b0531c1eeff3",
    "created_at": "2023-11-02T14:03:44Z",
    "updated_at": "2023-11-02T14:03:44Z",
    "added_by_id": 1,
    "sequence_id": "e4a747a3-a290-48da-b671-d3cd591f920b",
    "clicked_link": false,
    "scheduled_at": "2023-11-02T14:03:44.000000Z",
    "unsubscribed": false,
    "run_created_at": null,
    "run_updated_at": null,
    "voice_options": {},
    "contact_messages": []
  },
  "api_version": "v1",
  "event": "step_contact.created",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "c0831fd7-3ea3-5962-8523-1aea214c0a02"
}

step_contact.updated

A step contact record is updated (status, timing, and similar fields).

{
  "data": {
    "id": "8276e83f-21b1-4f16-b3a3-1a1a7c8e46f1",
    "status": "finished",
    "contact": {
      "id": "147363b7-3ce5-445f-9193-27e96f1cf12d",
      "name": "Giovanni Torp",
      "email": null,
      "phone": "+13603094336"
    },
    "step_id": "5137e2c4-fe04-4c55-8810-943b33fd0f72",
    "channel_id": "70c9cc95-e78b-4acf-9079-b0531c1eeff3",
    "created_at": "2023-11-02T14:03:44Z",
    "updated_at": "2023-11-02T14:03:45Z",
    "added_by_id": 1,
    "sequence_id": "e4a747a3-a290-48da-b671-d3cd591f920b",
    "clicked_link": false,
    "scheduled_at": "2023-11-02T14:03:44.000000Z",
    "unsubscribed": false,
    "run_created_at": "2023-11-02T14:03:45",
    "run_updated_at": "2023-11-02T14:03:46",
    "voice_options": {},
    "contact_messages": [
      {
        "id": "580ddf5c-1b53-404b-92d1-d03fcacd1c6a",
        "delivery_status": "delivered",
        "contact_id": "147363b7-3ce5-445f-9193-27e96f1cf12d",
        "conversation_id": "6c26b6a5-3525-4a5e-b1b9-3f409b79ae7b",
        "body": "I'm Batman!",
        "attachments": [
          {
            "url": "https://1.bp.blogspot.com/_J9PlRvGGXS8/Su46nKRk_wI/AAAAAAAABZQ/d73kC45JkGw/s400/batman-avatar-10.jpg",
            "content_type": "image/png"
          }
        ]
      }
    ]
  },
  "api_version": "v1",
  "event": "step_contact.updated",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "bbf8f720-657b-5c39-b140-4681ca36f284"
}

Did this page help you?