Merchant application requires action Webhook

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.omni-dev.integratedcommerce.io/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Omni API Dev MCP server": {
    "url": "https://docs.omni-dev.integratedcommerce.io/mcp"
  }
}

Close
POST https://webhook.example.com

This webhook event is triggered when a merchant application needs more information or documents from the merchant before review can continue.

Headers

  • svix-id string Required

    The unique message id for this delivery. Constant across retries of the same message.

  • svix-timestamp string Required

    The time the message was sent, as a Unix timestamp in seconds. Reject stale timestamps to protect against replay attacks.

  • svix-signature string Required

    One or more space-delimited signatures in the form v1,<base64 signature> — an HMAC-SHA256 over {svix-id}.{svix-timestamp}.{raw request body} keyed with the endpoint's signing secret. See the Webhook Configuration section for verification details.

application/json

Body

The request body for the merchant.application.requires_action webhook event.

  • event object Required

    Webhook event details for merchant lifecycle events. Extends the standard event envelope with the merchant the event relates to, once a merchant record exists.

    Hide event attributes Show event attributes object
    • id string Required

      Unique ID for this webhook event. A bare ULID — unlike transaction events, merchant lifecycle event ids carry no evt_ prefix.

    • type string Required

      The type of event that occurred.

    • timestamp string(date-time) Required

      The time when the event was triggered (UTC).

    • merchantId string | null Required

      The merchant this event relates to. Null for events that occur before a merchant record exists (e.g. application progress events).

  • data object Required

    Details for a merchant lifecycle event. Every field is always present; fields that do not apply to the event type are null. Payloads are PII-safe by design — they never carry underwriting documents, bank details, or tax identifiers.

    Hide data attributes Show data attributes object
    • isvId string Required

      Your ISV id.

    • merchantName string | null Required

      The merchant's business display name, when known.

    • applicationId string | null Required

      The merchant onboarding application this event relates to.

    • fromStatus string | null Required

      The application status before the transition, for application progress events.

    • toStatus string | null Required

      The application status after the transition, for application progress events.

    • reason string | null Required

      Human-readable reason accompanying a rejection decision, when one was provided.

    • templateName string | null Required

      The pricing template name, for pricing template decision events.

    • templateRegion string | null Required

      The pricing template region (US or CA), for pricing template decision events.

    • templateVersion string | null Required

      The pricing template version, for pricing template decision events.

Responses

  • 200 application/json

    Successful acknowledgement of a webhook event. The response should be a 200 OK status with an empty body.

POST MerchantApplicationRequiresAction
Request example
{
  "event": {
    "id": "01JZM7Q2XVGT5H8RC3W9K4N6PD",
    "type": "merchant.application.requires_action",
    "timestamp": "2026-07-09T14:30:00Z",
    "merchantId": null
  },
  "data": {
    "isvId": "isv_01JY9FCPM8Q5T2V7R4W1XKB6ZD",
    "merchantName": "Blue Bottle Bakery",
    "applicationId": "map_01JZM7RH2M8S6WV0P9RQD37GXE",
    "fromStatus": null,
    "toStatus": null,
    "reason": null,
    "templateName": null,
    "templateRegion": null,
    "templateVersion": null,
    "portalLink": "https://partner-portal.omni.integratedcommerce.io/merchants/applications/map_01JZM7RH2M8S6WV0P9RQD37GXE"
  }
}
Response examples (200)
{
  "value": {}
}