SettleMint
API referenceEvents

token.corporate-action.announced

A corporate action cleared its approval and is scheduled to execute, so holders can expect the distribution or change. Carries identifiers and the action type only; read terms and holder amounts through the corporate-action API.

Delivery contract

FieldValue
Event typetoken.corporate-action.announced
Version1
Lifecycle statefinal
Counter-signed receiptsNo event-specific advice
SDK typeWebhook.TokenCorporateActionAnnouncedV1

The receipt recommendation does not change delivery behavior. DALP waits for a counter-signed receipt only if the webhook endpoint's counterSignedReceipts value is true when DALP queues the delivery. When the value is false, a normal 2xx response completes the delivery.

Related references:

  • corporateActionId
  • tokenAddress

Payload schema

The schema and examples describe the full payload. Thin delivery omits personal data fields. Use the payload-shape guidance to choose the endpoint configuration.

{
  "type": "object",
  "properties": {
    "corporateActionId": {
      "type": "string"
    },
    "chainId": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "tokenAddress": {
      "type": "string",
      "minLength": 42,
      "maxLength": 42,
      "pattern": "^0x[a-fA-F0-9]{40}$",
      "description": "A valid Ethereum address (42 characters, starting with 0x)",
      "examples": ["0x71C7656EC7ab88b098defB751B7401B5f6d8976F"]
    },
    "actionType": {
      "type": "string",
      "enum": [
        "cashDividend",
        "bondCoupon",
        "bonusIssue",
        "rightsIssue",
        "capitalDecrease",
        "stockSplit",
        "spinOff",
        "maturityRedemption",
        "distribution",
        "partialRedemption",
        "conversion",
        "buyback",
        "coordinatedDistribution"
      ]
    },
    "occurredAt": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$"
    }
  },
  "required": ["corporateActionId", "chainId", "tokenAddress", "actionType", "occurredAt"],
  "additionalProperties": true
}

TypeScript SDK example

Use the request's raw body and headers with your endpoint's webhook secret. This handler illustrates verification and event selection. Before writing downstream state, deduplicate deliveries by evt_id and recognize replayed outcomes by their domain identifiers.

const result = await verifyWebhook({
  rawBody,
  headers,
  secret: process.env.DALP_WEBHOOK_SECRET!,
});

if (!result.ok) {
  throw new Error(`Webhook verification failed: ${result.code}`);
}

if (result.event.type === "token.corporate-action.announced") {
  const event: Webhook.Event<"token.corporate-action.announced"> = result.event;
  console.log(event.payload);
}

HTTP delivery example

This illustrative request shows the delivery shape. Its timestamp and signature are placeholders; a verifier rejects them. Use a signed platform delivery to verify your endpoint.

curl -X POST https://consumer.example.com/dalp/webhooks \
  -H "content-type: application/json" \
  -H "webhook-id: evt_358ed1a97bbc53a1ae5e105e505af778" \
  -H "webhook-timestamp: 1778112000" \
  -H "webhook-signature: v1,docs-example-signature" \
  --data '{"evt_id":"evt_358ed1a97bbc53a1ae5e105e505af778","source_id":"example:token.corporate-action.announced@1:0","lifecycle_state":"final","payload":{"corporateActionId":"0192a4c1-5f3e-7a01-9b2c-3d4e5f607183","chainId":537001,"tokenAddress":"0xdddddddddddddddddddddddddddddddddddddddd","actionType":"cashDividend","occurredAt":"2026-09-28T09:20:00.000Z"},"related":{"corporateActionId":"corporateActionId_example","tokenAddress":"tokenAddress_example"},"type":"token.corporate-action.announced","version":1,"request":{"idempotency_key":"idem_01JZP7R5W8M9N0P1Q2R3S4T5"}}'

Version and manifest

This page documents version 1 of token.corporate-action.announced. This event type is not deprecated. The DALP events manifest contains the machine-readable AsyncAPI entry.

On this page