Boarding Webhook Examples | Run Developers

One example payload for each merchant status event. Every status event has the same payload fields. Field values, trigger, and reason vary with the merchant and the action that caused the change. For field descriptions and every trigger and reason value, see Boarding Webhooks.

`merchant.new`

Sent when a merchant’s status changes to new (merchant_status_id 1). It’s also sent when a merchant is created.

{
  "event_type": "merchant.new",
  "source_id": "133000",
  "timestamp": "2025-09-11T15:30:45.123Z",
  "payload": {
    "merchant_id": 133000,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128000,
    "dba_name": "New Business Venture",
    "merchant_status_id": 1,
    "external_crm_id": null,
    "custom_01": null,
    "trigger": "api",
    "reason": "created",
    "timestamp": "2025-09-11T15:30:45.100+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600010",
    "attempt": 1,
    "idempotency_key": "7e1a2b3c4d5e6f708192a3b4c5d6e7f8"
  }
}

`merchant.sent_for_signature`

Sent when a merchant’s status changes to sent_for_signature (merchant_status_id 2).

{
  "event_type": "merchant.sent_for_signature",
  "source_id": "133001",
  "timestamp": "2025-09-11T19:42:24.438Z",
  "payload": {
    "merchant_id": 133001,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128001,
    "dba_name": "Example Coffee Co",
    "merchant_status_id": 2,
    "external_crm_id": null,
    "custom_01": null,
    "trigger": "api",
    "reason": "sent_for_signature",
    "timestamp": "2025-09-11T19:42:24.420+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600011",
    "attempt": 1,
    "idempotency_key": "9b8a7c6d5e4f3a2b1c0d9e8f7a6b5c4d"
  }
}

`merchant.signed`

Sent when a merchant’s status changes to signed (merchant_status_id 3).

{
  "event_type": "merchant.signed",
  "source_id": "133002",
  "timestamp": "2025-09-12T08:15:30.456Z",
  "payload": {
    "merchant_id": 133002,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128002,
    "dba_name": "Downtown Coffee Shop",
    "merchant_status_id": 3,
    "external_crm_id": null,
    "custom_01": null,
    "trigger": "ui",
    "reason": "signed",
    "timestamp": "2025-09-12T08:15:30.420+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600012",
    "attempt": 1,
    "idempotency_key": "a1b2c3d4e5f60718293a4b5c6d7e8f90"
  }
}

`merchant.in_underwriting`

Sent when a merchant’s status changes to in_underwriting (merchant_status_id 4).

{
  "event_type": "merchant.in_underwriting",
  "source_id": "133003",
  "timestamp": "2025-09-12T14:20:15.789Z",
  "payload": {
    "merchant_id": 133003,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128003,
    "dba_name": "Mountain View Restaurant",
    "merchant_status_id": 4,
    "external_crm_id": null,
    "custom_01": null,
    "trigger": "system",
    "reason": "in_underwriting",
    "timestamp": "2025-09-12T14:20:15.750+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600013",
    "attempt": 1,
    "idempotency_key": "b2c3d4e5f60718293a4b5c6d7e8f90a1"
  }
}

`merchant.boarded`

Sent when a merchant’s status changes to boarded (merchant_status_id 5).

{
  "event_type": "merchant.boarded",
  "source_id": "133004",
  "timestamp": "2025-09-13T10:45:22.334Z",
  "payload": {
    "merchant_id": 133004,
    "mid": "800000000000",
    "rep_code_id": 5000,
    "customer_id": 128004,
    "dba_name": "Tech Solutions Inc",
    "merchant_status_id": 5,
    "external_crm_id": "CRM-2025-001",
    "custom_01": "APPROVED",
    "trigger": "system",
    "reason": "boarded",
    "timestamp": "2025-09-13T10:45:22.300+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600014",
    "attempt": 1,
    "idempotency_key": "c3d4e5f60718293a4b5c6d7e8f90a1b2"
  }
}

`merchant.live`

Sent when a merchant’s status changes to live (merchant_status_id 6).

{
  "event_type": "merchant.live",
  "source_id": "133005",
  "timestamp": "2025-09-13T16:20:33.567Z",
  "payload": {
    "merchant_id": 133005,
    "mid": "800000000000",
    "rep_code_id": 5000,
    "customer_id": 128005,
    "dba_name": "Online Retail Store",
    "merchant_status_id": 6,
    "external_crm_id": "CRM-2025-002",
    "custom_01": "LIVE",
    "trigger": "system",
    "reason": "live",
    "timestamp": "2025-09-13T16:20:33.520+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600015",
    "attempt": 1,
    "idempotency_key": "d4e5f60718293a4b5c6d7e8f90a1b2c3"
  }
}

`merchant.cancelled`

Sent when a merchant’s status changes to cancelled (merchant_status_id 21).

{
  "event_type": "merchant.cancelled",
  "source_id": "133006",
  "timestamp": "2025-09-13T11:30:45.234Z",
  "payload": {
    "merchant_id": 133006,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128006,
    "dba_name": "Cancelled Business",
    "merchant_status_id": 21,
    "external_crm_id": null,
    "custom_01": "CANCELLED",
    "trigger": "ui",
    "reason": "cancelled",
    "timestamp": "2025-09-13T11:30:45.200+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600016",
    "attempt": 1,
    "idempotency_key": "e5f60718293a4b5c6d7e8f90a1b2c3d4"
  }
}

`merchant.declined`

Sent when a merchant’s status changes to declined (merchant_status_id 41).

{
  "event_type": "merchant.declined",
  "source_id": "133007",
  "timestamp": "2025-09-13T13:15:22.890Z",
  "payload": {
    "merchant_id": 133007,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128007,
    "dba_name": "High Risk Venture",
    "merchant_status_id": 41,
    "external_crm_id": "CRM-2025-DECLINED",
    "custom_01": "DECLINED",
    "trigger": "ui",
    "reason": "declined",
    "timestamp": "2025-09-13T13:15:22.850+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600017",
    "attempt": 1,
    "idempotency_key": "f60718293a4b5c6d7e8f90a1b2c3d4e5"
  }
}

`merchant.unknown`

Sent when a merchant’s status changes to unknown (merchant_status_id 62).

{
  "event_type": "merchant.unknown",
  "source_id": "133008",
  "timestamp": "2025-09-13T09:45:11.123Z",
  "payload": {
    "merchant_id": 133008,
    "mid": null,
    "rep_code_id": 5000,
    "customer_id": 128008,
    "dba_name": "Status Unknown Business",
    "merchant_status_id": 62,
    "external_crm_id": null,
    "custom_01": "ERROR",
    "trigger": "system",
    "reason": "status_changed",
    "timestamp": "2025-09-13T09:45:11.100+00:00"
  },
  "metadata": {
    "webhook_id": "wh_600018",
    "attempt": 1,
    "idempotency_key": "0718293a4b5c6d7e8f90a1b2c3d4e5f6"
  }
}