Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Account Service

Webhooks API Reference

Open Direct API Reference Page

MethodPathDescription
POST/transaction-notifyNotify transaction

Reference Table

NamePathDescription
TransactionType#/components/schemas/TransactionType
TxWebhookRspBase#/components/schemas/TxWebhookRspBase
PublishHandleOpts#/components/schemas/PublishHandleOpts
SIWFOpts#/components/schemas/SIWFOpts
PublishKeysOpts#/components/schemas/PublishKeysOpts
PublishGraphKeysOpts#/components/schemas/PublishGraphKeysOpts
TxWebhookOpts#/components/schemas/TxWebhookOpts
PublishHandleWebhookRsp#/components/schemas/PublishHandleWebhookRsp
SIWFWebhookRsp#/components/schemas/SIWFWebhookRsp
PublishKeysWebhookRsp#/components/schemas/PublishKeysWebhookRsp
PublishGraphKeysWebhookRsp#/components/schemas/PublishGraphKeysWebhookRsp
RetireMsaWebhookRsp#/components/schemas/RetireMsaWebhookRsp
RevokeDelegationWebhookRsp#/components/schemas/RevokeDelegationWebhookRsp
TxWebhookRsp#/components/schemas/TxWebhookRsp

Path Details

[POST]/transaction-notify

  • Summary
    Notify transaction

RequestBody

  • application/json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/PublishHandleWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/SIWFWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/PublishKeysWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/PublishGraphKeysWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/RetireMsaWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/RevokeDelegationWebhookRsp"
    }
  ]
}

Responses

  • 200 Successful notification

  • 400 Bad request

References

#/components/schemas/TransactionType

{
  "type": "string",
  "enum": [
    "CHANGE_HANDLE",
    "CREATE_HANDLE",
    "SIWF_SIGNUP",
    "SIWF_SIGNIN",
    "ADD_KEY",
    "RETIRE_MSA",
    "ADD_PUBLIC_KEY_AGREEMENT",
    "REVOKE_DELEGATION"
  ],
  "x-enum-varnames": [
    "CHANGE_HANDLE",
    "CREATE_HANDLE",
    "SIWF_SIGNUP",
    "SIWF_SIGNIN",
    "ADD_KEY",
    "RETIRE_MSA",
    "ADD_PUBLIC_KEY_AGREEMENT",
    "REVOKE_DELEGATION"
  ]
}

#/components/schemas/TxWebhookRspBase

{
  providerId: string
  referenceId: string
  msaId: string
  transactionType?: enum[CHANGE_HANDLE, CREATE_HANDLE, SIWF_SIGNUP, SIWF_SIGNIN, ADD_KEY, RETIRE_MSA, ADD_PUBLIC_KEY_AGREEMENT, REVOKE_DELEGATION]
}

#/components/schemas/PublishHandleOpts

{
  handle: string
}

#/components/schemas/SIWFOpts

{
  handle: string
  accountId: string
}

#/components/schemas/PublishKeysOpts

{
  newPublicKey: string
}

#/components/schemas/PublishGraphKeysOpts

{
  schemaId: string
}

#/components/schemas/TxWebhookOpts

{
}

#/components/schemas/PublishHandleWebhookRsp

{
}

#/components/schemas/SIWFWebhookRsp

{
}

#/components/schemas/PublishKeysWebhookRsp

{
}

#/components/schemas/PublishGraphKeysWebhookRsp

{
}

#/components/schemas/RetireMsaWebhookRsp

{
}

#/components/schemas/RevokeDelegationWebhookRsp

{
}

#/components/schemas/TxWebhookRsp

{
  "oneOf": [
    {
      "$ref": "#/components/schemas/PublishHandleWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/SIWFWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/PublishKeysWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/PublishGraphKeysWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/RetireMsaWebhookRsp"
    },
    {
      "$ref": "#/components/schemas/RevokeDelegationWebhookRsp"
    }
  ]
}