Agent action pending approval webhook

Fired when an agent submits an action that requires platform approval before Grid will execute it. Use this to send a push notification to the customer so they can review and approve or reject the action in your app. This endpoint should be implemented by clients of the Grid API.

Authentication

The webhook includes a signature in the X-Grid-Signature header that allows you to verify that the webhook was sent by Grid. To verify the signature:

1. Get the Grid public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

The payload contains the full AgentAction — including the embedded quote or transfer details — so you can render the approval UI without a second API call. Approve or reject via POST /agents/{agentId}/actions/{actionId}/approve or POST /agents/{agentId}/actions/{actionId}/reject.

WEBHOOK agent-action

pendingApproval

{
  "id": "Webhook:019542f5-b3e7-1d02-0000-000000000020",
  "type": "AGENT_ACTION.PENDING_APPROVAL",
  "timestamp": "2025-10-03T15:00:00Z",
  "data": {
    "id": "AgentAction:019542f5-b3e7-1d02-0000-000000000099",
    "agentId": "Agent:019542f5-b3e7-1d02-0000-000000000042",
    "customerId": "Customer:019542f5-b3e7-1d02-0000-000000000010",
    "platformCustomerId": "user-a1b2c3",
    "status": "PENDING_APPROVAL",
    "type": "EXECUTE_QUOTE",
    "quote": {
      "id": "Quote:019542f5-b3e7-1d02-0000-000000000006",
      "status": "PENDING",
      "expiresAt": "2025-10-03T15:00:30Z",
      "createdAt": "2025-10-03T15:00:00Z",
      "source": {
        "sourceType": "ACCOUNT",
        "accountId": "InternalAccount:a12dcbd6-dced-4ec4-b756-3c3a9ea3d123"
      },
      "destination": {
        "destinationType": "ACCOUNT",
        "accountId": "ExternalAccount:e85dcbd6-dced-4ec4-b756-3c3a9ea3d965"
      },
      "sendingCurrency": {
        "code": "USD",
        "name": "United States Dollar",
        "symbol": "$",
        "decimals": 2
      },
      "receivingCurrency": {
        "code": "INR",
        "name": "Indian Rupee",
        "symbol": "₹",
        "decimals": 2
      },
      "totalSendingAmount": 50000,
      "totalReceivingAmount": 4625000,
      "exchangeRate": 92.5,
      "feesIncluded": 250,
      "transactionId": "Transaction:019542f5-b3e7-1d02-0000-000000000099"
    },
    "createdAt": "2025-10-03T15:00:00Z",
    "updatedAt": "2025-10-03T15:00:00Z"
  }
}

401

{
  "status": 401,
  "code": "UNAUTHORIZED",
  "message": "<string>",
  "details": {}
}

Authorizations

X-Grid-Signature · string · header · required

Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used to verify that the webhook was sent by Grid. To verify the signature:

1. Get the Grid public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

Body

application/json

id · string · required

Unique identifier for this webhook delivery (can be used for idempotency)

Example:

"Webhook:019542f5-b3e7-1d02-0000-000000000007"

type · enum<string> · required

Status-specific event type in OBJECT.EVENT dot-notation (e.g., OUTGOING_PAYMENT.COMPLETED)

Available options: AGENT_ACTION.PENDING_APPROVAL

timestamp · string<date-time> · required

ISO 8601 timestamp of when the webhook was sent

Example:

"2025-08-15T14:32:00Z"

data · object · required

An action submitted by an agent that may require platform approval before execution. All agent-initiated operations (quote execution, transfers) are represented as AgentActions, giving the platform a consistent object to approve, reject, and audit regardless of the underlying operation type.

Show child attributes

Response

200

Webhook received and acknowledged.