Sequence Runs

Events that fire when a sequence run is created or updated.

Events that fire when a sequence run is created or updated.

Events

EventWhen it fires
sequence_run.createdA contact starts a sequence run.
sequence_run.updatedA sequence run is updated.

Examples

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

sequence_run.created

A contact starts a sequence run.

{
  "data": {
    "id": "f15d4795-a747-4d56-9109-6a5b4d18f295",
    "status": "active",
    "contact": {
      "id": "147363b7-3ce5-445f-9193-27e96f1cf12d",
      "name": "Giovanni Torp",
      "email": null,
      "phone": "+13603094336"
    },
    "channel_id": null,
    "created_at": "2023-11-02T14:03:45Z",
    "updated_at": "2023-11-02T14:03:45Z",
    "added_by_id": null,
    "sequence_id": "e4a747a3-a290-48da-b671-d3cd591f920b",
    "last_step_id": "5137e2c4-fe04-4c55-8810-943b33fd0f72",
    "custom_data": {
      "placement": {
        "id": "0b8a6c1e-3f0d-4c2a-9d57-1f6e2b7c4a90",
        "external_id": "PL-1001"
      }
    },
    "step_contacts": []
  },
  "api_version": "v1",
  "event": "sequence_run.created",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "af0dcc64-8758-5b68-9b0d-d2de26aca5e5"
}

sequence_run.updated

A sequence run is updated.

{
  "data": {
    "id": "f15d4795-a747-4d56-9109-6a5b4d18f295",
    "status": "finished",
    "contact": {
      "id": "147363b7-3ce5-445f-9193-27e96f1cf12d",
      "name": "Giovanni Torp",
      "email": null,
      "phone": "+13603094336"
    },
    "channel_id": "70c9cc95-e78b-4acf-9079-b0531c1eeff3",
    "created_at": "2023-11-02T14:03:45Z",
    "updated_at": "2023-11-02T14:03:46Z",
    "added_by_id": 1,
    "sequence_id": "e4a747a3-a290-48da-b671-d3cd591f920b",
    "last_step_id": "20020b31-f015-4713-bd31-01fca79dbf0e",
    "custom_data": {
      "placement": {
        "id": "0b8a6c1e-3f0d-4c2a-9d57-1f6e2b7c4a90",
        "external_id": "PL-1001"
      }
    },
    "step_contacts": [
      {
        "id": "8276e83f-21b1-4f16-b3a3-1a1a7c8e46f1",
        "status": "finished",
        "step_id": "5137e2c4-fe04-4c55-8810-943b33fd0f72",
        "clicked_link": false,
        "unsubscribed": false,
        "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"
              }
            ]
          }
        ]
      },
      {
        "id": "7fccfa0f-7397-4da3-9034-34cc14994ab0",
        "status": "finished",
        "step_id": "20020b31-f015-4713-bd31-01fca79dbf0e",
        "clicked_link": false,
        "unsubscribed": false,
        "contact_messages": []
      }
    ]
  },
  "api_version": "v1",
  "event": "sequence_run.updated",
  "created_at": "2025-08-19T06:40:57.416929Z",
  "request_id": "3dc1a6e4-3799-55af-85e5-15182d4ce2a3"
}

Did this page help you?