Account Webhooks

📘
To see a complete list of all Spidr webhook fields and their descriptions, please reference: Webhook Field Index

account.create

Description: The account.create webhook contains details about an account created via the Create Account endpoint.
Trigger: Successful API call to the Create Account endpoint.

Example:

{
  "uuid": "e147954f-adce-4036-afaa-ef9378737b68",
  "accountId": "6883af86c3ccc95b23440257",
  "actionRequestor": {
    "source": "api"
  },
  "companyId": "6823a83c644d753f0f79a8ec",
  "requestId": "045105564a82e857eee3b90eaedc755a",
  "responseBody": {
    "accountId": "6883af86c3ccc95b23440257",
    "productId": "6833a83e59a0f48f78787c29",
    "accountNumber": "594101055555",
    "card": {
      "cardId": "6883af86c3cdc95b2344025b",
      "cardNumber": "555555XXXXXX4549",
      "cardExpiryDate": "2029-07-25T00:00:00.000Z",
      "embossUuid": "38F8B962-09B9-4AF6-E063-0110007FD954",
			"spidrActionId": "6883af85c3ccc95b23441258"
    },
  },
  "spidrActionId": "6883af85c3ccc95b23441258",
  "userId": "688254c7c2ea932ee44936cd",
  "productId": "6823a83e59a0f48f78787a29",
  "webhookType": "account.create"
}

account.statusUpdate

Description: The account.statusUpdate webhook contains details about account status changes. It will return the original and new account status values. Account statuses can be updated via API or SST.
Triggers:
- Successful API call to the Edit Account endpoint.
- Account status updated via the appropriate SST role. If updated via SST, the userID and userEmail of the user who performed the update will be included.

Example:

{
  "uuid": "dcf88014-1c41-400c-aa7a-2995794b1d39",
  "accountId": "6883af75c3ccc96b23440241",
  "actionRequestor": {
    "source": "user",
    "userId": "680ec214b10b6cd94b8f73eb",
    "userEmail": "[email protected]",
    "userIdSource": "internal"
  },
  "companyId": "6823a83c743d753f0f79a8ec",
  "requestId": "20d6f903be1d1859f65f72540e5def30",
  "responseBody": {
    "newStatus": "closed",
    "statusReason": "close_without_refund",
    "spidrActionId": "6883b1725da8181b73fc0a06"
  },
  "spidrActionId": "6883b1725da8181b73fc0a06",
  "userId": "688254c7c2ea832ee44936cc",
  "productId": "6823a83e69a0f48f78787c29",
  "webhookType": "account.statusUpdate",
  "changes": [
    {
      "field": "status",
      "oldValue": "active",
      "newValue": "closed"
    },
    {
      "field": "statusReason",
      "oldValue": null,
      "newValue": "close_without_refund"
    }
  ]
}

account.featureUpdate

Description: The account.featureUpdate webhook contains details about the account/card features that were updated for an account. It will return the old feature values if applicable. Account features can be updated via API or SST.
Triggers:
- Successful API call to the Edit Account Features endpoint.
- Account features updated via the appropriate SST role. If updated via SST, the userID and userEmail of the user who performed the update will be included.

Example:

{
  "uuid": "80d13808-c45d-4bb2-b604-2af08ca0a3cf",
  "accountId": "688aaa939b9dcf3ad5bfdcf2",
  "actionRequestor": {
    "source": "api"
  },
  "companyId": "6823a83c643d753f0f79a9ec",
  "requestId": "68551c27ddcd566e8ce5c410dd82c429",
  "responseBody": {
    "updated": true,
    "accountId": "687aaa939b9dcf3ad5bfdcf1",
    "spidrActionId": "687e811d9b9dcf3ad5bfe245"
  },
  "spidrActionId": "687e811d9b9dcf3ad5bfe245",
  "userId": "687aaa8d9b9dcf3ad5bfdce5",
  "changes": [
    {
      "field": "accountFeatures.card_blocks",
      "oldValue": {
        "type": "card_blocks",
        "value": "block_physical",
        "startDate": "2025-07-18T20:12:05.981Z",
        "endDate": "3000-01-01T00:00:00.000Z"
      },
      "newValue": {
        "type": "card_blocks",
        "value": "block_none",
        "startDate": "2025-07-21T18:08:29.607Z",
        "endDate": "3000-01-01T00:00:00.000Z"
      }
    }
  ],
  "productId": "6823a83e59a0f48f78787c29",
  "webhookType": "account.featureUpdate"
}

account.shippingAddressUpdate

Description: The account.shippingAddressUpdate webhook contains details about updates to the account's shipping address info. It will return the original and new values for any address fields that were changed. The account's shipping address can be updated via API or SST.
Trigger:
- Successful API call to the Edit Account endpoint.
- Shipping address updated via the appropriate SST role. If updated via SST, the userID and userEmail of the user who performed the update will be included.

Example:

{
  "uuid": "bd85232b-e1f4-4266-8d14-0e521f104390",
  "accountId": "6885f3e2fd18f2d0fa9c6dfc",
  "actionRequestor": {
    "source": "user",
    "userId": "671ec214b10b6cd94b8f73eb",
    "userEmail": "[email protected]",
    "userIdSource": "internal"
  },
  "companyId": "6824a83c643d753f0f79a8ec",
  "requestId": "91daf4169debda12f3b475012ac9c531",
  "responseBody": {
    "spidrActionId": "68164322b8f1753eb3795c54"
  },
  "spidrActionId": "68164322b8f1753eb3795c54",
  "userId": "6895f4ddfd18f2d0fa9c6dee",
  "productId": "6823b83e59a0f48f78787c29",
  "webhookType": "account.shippingAddressUpdate",
  "changes": [
    {
      "field": "shippingAddress.address1",
      "oldValue": "555 Woodland Ave",
      "newValue": "444 Woodland Ave"
    }
  ]
}

Account Endpoints that Support ZTM Risk Checks

🕷️
ZTM checks
ZTM risk data will be returned in webhook payloads if your program is configured for ZTM and risk checks are ran for the given endpoint call (bypassZtm = false).
A list of 'Account' endpoints that support ZTM checks are listed below, as well as an example payload with ZTM risk data included.

Endpoint that supports ZTM checks	Corresponding Webhook(s)
Create Account	account.create
Edit Account	account.statusUpdate account.shippingAddressUpdate
Edit Account Features	account.featureUpdate

Example Account Webhook with ZTM Payload Included:

    {
  "uuid": "604af35e-1337-49a6-b275-5b9f2aa48498",
  "accountId": "687713e1eb61c81e2f9b783a",
  "actionRequestor": {
    "source": "api"
  },
  "companyId": "6823a93c643d753f0f79a8ec",
  "requestId": "00c19609920b7761bc16ab335ef08148",
  "responseBody": {
    "accountId": "687814e1eb61c81e2f9b783a",
    "productId": "6823a93e59a0f48f78787c29",
    "accountNumber": "594101055555",
    "card": {
      "cardId": "687813e2ec61c81e2f9b783e",
      "cardNumber": "555555XXXXXX5261",
      "cardExpiryDate": "2029-04-16T00:00:00.000Z",
      "embossUuid": "38D08045-DFB6-199C-E063-0100007F7DDB"
    },
    "ztmData": {
      "isTrainingMode": true,
      "riskLevel": "low",
      "providerSummary": {
        "riskLevel": "low",
        "riskConfigurationId": "nyGrZSlprJmVu7Cg",
        "providerLevels": [
          {
            "provider": "sardine",
            "riskLevel": "low"
          }
        ],
        "workflowExecutionId": "2178"
      },
      "providerResponses": [
        {
          "provider": "sardine",
          "level": "low",
          "sessionKey": "cf3875bcc10a5d743a05c5aaf1edc858e645",
          "flowId": "1139cf42-42e1-442b-9e3c-2622c6e06e88",
          "flowName": "flow-account-create",
          "flowType": "account_update",
          "customer": {
            "score": 0,
            "level": "low",
            "rules": []
          },
          "providerData": {
            "sessionKey": "cf3875bdc20a5d743a05c5aaf1edc858e645",
            "level": "low",
            "status": "Success",
            "customer": {
              "score": 0,
              "level": "low",
              "reasonCodes": ["AL4", "AL5", "AL9"],
              "signals": [
                {
                  "key": "addressRiskLevel",
                  "value": "unknown",
                  "reasonCodes": ["AL4", "AL5", "AL9"]
                },
                {
                  "key": "emailDomainLevel",
                  "value": "unknown"
                },
                {
                  "key": "emailLevel",
                  "value": "unknown"
                },
                {
                  "key": "pepLevel",
                  "value": "low"
                },
                {
                  "key": "phoneLevel",
                  "value": "unknown"
                },
                {
                  "key": "sanctionLevel",
                  "value": "low"
                }
              ],
              "address": {
                "validity": "invalid"
              }
            },
            "transaction": {
              "level": "low",
              "amlLevel": "low"
            },
            "checkpoints": {
              "customer": {
                "riskLevel": {
                  "value": "low",
                  "ruleIds": null
                }
              }
            },
            "checkpointData": [
              {
                "name": "customer",
                "type": "weighted_max"
              }
            ]
          }
        }
      ],
      "providerErrors": []
    },
    "spidrActionId": "687813e1eb67c81e2f9b783b"
  },
  "spidrActionId": "687813e1eb67c81e2f9b783b",
  "userId": "6878d315eb61c81e2f9b7698",
  "productId": "6123a83e59a0f48f78787c29",
  "webhookType": "account.create"
}