Account Service

Webhooks API Reference

Open Direct API Reference Page

Path Table

Reference Table

Path Details

[GET]/healthz

• Summary
  Check the health status of the service

Responses

• 200 Service is healthy

[POST]/webhooks/transaction-notify

• Summary
  Notify transaction

RequestBody

• application/json

undefined?: #/components/schemas/OnChainContentWebhookRsp | #/components/schemas/CreateHandleWebhookRsp | #/components/schemas/ChangeHandleWebhookRsp | #/components/schemas/SIWFWebhookRsp | #/components/schemas/PublishKeysWebhookRsp | #/components/schemas/PublishGraphKeysWebhookRsp | #/components/schemas/RetireMsaWebhookRsp | #/components/schemas/RevokeDelegationWebhookRsp | #/components/schemas/CapacityBatchAllWebhookRsp

Responses

• 200 Successful notification

• 400 Bad request

References

#/components/schemas/TransactionType

enum[ON_CHAIN_CONTENT, CHANGE_HANDLE, CREATE_HANDLE, SIWF_SIGNUP, SIWF_SIGNIN, ADD_KEY, RETIRE_MSA, ADD_PUBLIC_KEY_AGREEMENT, REVOKE_DELEGATION, CAPACITY_BATCH]

#/components/schemas/TxWebhookRspBase

{
  blockHash: string
  providerId: string
  referenceId: string
  msaId?: string
  txHash: string
}

#/components/schemas/OnChainContentOpts

{
  msaId: string
  intentId: string
  schemaId: string
}

#/components/schemas/PublishHandleOpts

{
  handle: string
}

#/components/schemas/SIWFOpts

{
  handle: string
  accountId: string
}

#/components/schemas/PublishKeysOpts

{
  newPublicKey: string
}

#/components/schemas/PublishGraphKeysOpts

{
  schemaId: string
}

#/components/schemas/CapacityBatchAllOpts

{
  calls: {
    section: string
    method: string
  }[]
  capacityWithdrawnEvent: {
    msaId: string
    amount: string
  }
}

#/components/schemas/TxWebhookOpts

{
}

#/components/schemas/CreateHandleWebhookRsp

{
}

#/components/schemas/OnChainContentWebhookRsp

{
}

#/components/schemas/ChangeHandleWebhookRsp

{
}

#/components/schemas/PublishHandleWebhookRsp

{
}

#/components/schemas/SIWFWebhookRsp

{
}

#/components/schemas/PublishKeysWebhookRsp

{
}

#/components/schemas/PublishGraphKeysWebhookRsp

{
}

#/components/schemas/RetireMsaWebhookRsp

{
}

#/components/schemas/RevokeDelegationWebhookRsp

{
}

#/components/schemas/CapacityBatchAllWebhookRsp

{
}

#/components/schemas/TxWebhookRsp

undefined?: #/components/schemas/OnChainContentWebhookRsp | #/components/schemas/CreateHandleWebhookRsp | #/components/schemas/ChangeHandleWebhookRsp | #/components/schemas/SIWFWebhookRsp | #/components/schemas/PublishKeysWebhookRsp | #/components/schemas/PublishGraphKeysWebhookRsp | #/components/schemas/RetireMsaWebhookRsp | #/components/schemas/RevokeDelegationWebhookRsp | #/components/schemas/CapacityBatchAllWebhookRsp