Skip to main content

Webhook: Success

  • In the edeXa platform, webhooks facilitate real-time communication and seamless integration. When adding a stamp, a webhook success response provides confirmation of a successful operation.
  • Here user explores the structure and significance of the webhook success response for developers integrating stamp addition in the edeXa platform.
  • The edeXa webhooks server will look for a response to confirm the webhook notification was received. All webhook events should receive an HTTP-200 (OK) response.

Understanding the Webhook Success Response​

After successfully adding a stamp, the webhook success response contains vital information:

info
Success Webhook Details
Webhook Response 
{
  "webhookId": "6475b0af7195267fd13bb3d1",
  "actionId": "6475a47ed251164c916a830e",
  "action": "succeed",
  "data": {
    "_id": "6475c02029b5bab6d2f2c6dc",
    "userId": "646f1d74d3397a4********",
    "blockchainId": "2d4cf0b1-a3ee-4580-97f4-86bf937190fe",
    "txId": "0x3b7d586651f386c0d415fa1349b9ec0be07b78c86",
    "hash": "6d6db6c12243mdhfrehrdfghju76",
    "type": "0",
    "code": "bd5c9e",
    "isPrivateBc": false,
    "status": 1,
    "createdAt": "2023-05-30T09:21:36.966Z",
    "updatedAt": "2023-05-30T09:21:46.610Z"
  }
}
Details about webhook response perameters
KeyValueTypeDescription
webhookId6475b0af7195267fd13bb3d1StringAn webhook id, generated corrospond to webhook
actionId6475a47ed251164c916a830eStringAn action id, generated corrospond to webhook
actionsucceedStringAction type of webhook, details are:
    succeed : When webhook successfully returns txId of stamped file.
    failed : When webhook unable to provied txId corrospond to stamped file.
_id6475c02029b5bab6d2f2c6dcStringThe id generated for stamped hash or file
userId646f1d74d3397a4********StringId of user, who is stampin file
blockchainId2d4cf0b1-a3ee-4580-97f4-86bf937190feStringBlockchain id corrospond to stamped file. generated from blockchain side
txId0x3b7d586651f386c0d415fa1349b9ec0be07b78c86StringTransaction id corrospond to hash, used for stamping
hash6d6db6c12243mdhfrehrdfghju76StringAn string which user want to stamp
type0StringThe id generated for stamped hash or file
codebd5c9eStringAn short code, generated with respect to stamped hash
isPrivateBcfalseBooleanType of blockchain, on which hash is stamped
    For Private Blockchain: true
    For Public Blockchain: false
status1NumberCurrent status of stamped hash, returned from webhook. Deatils about status are:
    0: Waiting for the response to be received and processed
    1: Response received successfully, indicating a successful operation
    2: Response received with an error or unsuccessful outcome
createdAt2023-05-30T09:21:36.966ZDateTimestamp when hash stamped
updatedAt2023-05-31T09:21:36.966ZDateLast updated time stamp

Significance of the Webhook Success Response​

The webhook success response offers key advantages to developers:

  • Confirmation: Users receive assurance that the stamp addition process was successful, maintaining system integrity and enhancing the user experience.
  • Synchronization: The response allows synchronization of records between the requesting application and edeXa platform, ensuring consistency across systems.
  • Workflow Progression: The response acts as a trigger for subsequent actions or notifications, automating workflow tasks and optimizing business operations.

Conclusion​

The webhook success response is crucial for confirming a successful stamp addition in the edeXa platform. It provides clarity, synchronization, and workflow optimization for developers integrating with edeXa.

🖖 Become a part of bStamp community​

Connect and get the latest updates of bStamp : bStamp Discord

Last updated on