Skip to content
This repository was archived by the owner on Feb 17, 2026. It is now read-only.

Latest commit

 

History

History
145 lines (104 loc) · 5.42 KB

WebhookApi.md

File metadata and controls

145 lines (104 loc) · 5.42 KB

WebhookApi

All URIs are relative to https://api.originstamp.com

Method HTTP request Description
getWebhookStatus POST /v3/webhook/information Webhook
registerWebhookNotification POST /v3/webhook/register Webhook
triggerTimestampWebhook POST /v3/webhook/start Dev

getWebhookStatus

DefaultOfWebhookResponse getWebhookStatus(authorization, webhookRequest)

Webhook

RESTful interface to receive the status of a webhook. Based on the input parameters (target URL, hash and currency), we look up the most recent entry in the notification queue.This method is intended to support the webhook integration.

Example

// Import classes:
//import com.originstamp.api.client.ApiException;
//import com.originstamp.api.WebhookApi;

WebhookApi apiInstance = new WebhookApi();
String authorization = "authorization_example"; // String | A valid API key is essential for authorization to handle the request.
WebhookRequest webhookRequest = new WebhookRequest(); // WebhookRequest | DTO for registering webhook information.
try {
    DefaultOfWebhookResponse result = apiInstance.getWebhookStatus(authorization, webhookRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhookApi#getWebhookStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
authorization String A valid API key is essential for authorization to handle the request.
webhookRequest WebhookRequest DTO for registering webhook information.

Return type

DefaultOfWebhookResponse

Authorization

[API Key Authorization](../README.md#API Key Authorization)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

registerWebhookNotification

DefaultOfVoid registerWebhookNotification(authorization, webhookRequest)

Webhook

Method which allows a subscription for a webhook notification. If this method is called, a new entry is added to notification queue that is triggered as soon as a tamper-proof timestamp or the hash is created. An empty data payload means that the entry was created successfully.

Example

// Import classes:
//import com.originstamp.api.client.ApiException;
//import com.originstamp.api.WebhookApi;

WebhookApi apiInstance = new WebhookApi();
String authorization = "authorization_example"; // String | A valid API key is essential for authorization to handle the request.
WebhookRequest webhookRequest = new WebhookRequest(); // WebhookRequest | DTO for querying webhook information.
try {
    DefaultOfVoid result = apiInstance.registerWebhookNotification(authorization, webhookRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhookApi#registerWebhookNotification");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
authorization String A valid API key is essential for authorization to handle the request.
webhookRequest WebhookRequest DTO for querying webhook information.

Return type

DefaultOfVoid

Authorization

[API Key Authorization](../README.md#API Key Authorization)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

triggerTimestampWebhook

DefaultOfstring triggerTimestampWebhook(authorization, manualWebhookRequest)

Dev

With this interface you can trigger manual webhook to see how a webhook looks like. Please use a hash, that was already timestamped before such as https://redir.originstamp.com/hash/9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08 . Usually, the webhook is triggered as soon as the tamper-proof time stamp with the selected crypto currency has been created.

Example

// Import classes:
//import com.originstamp.api.client.ApiException;
//import com.originstamp.api.WebhookApi;

WebhookApi apiInstance = new WebhookApi();
String authorization = "authorization_example"; // String | A valid API key is essential for authorization to handle the request.
ManualWebhookRequest manualWebhookRequest = new ManualWebhookRequest(); // ManualWebhookRequest | DTO for webhook request.
try {
    DefaultOfstring result = apiInstance.triggerTimestampWebhook(authorization, manualWebhookRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling WebhookApi#triggerTimestampWebhook");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
authorization String A valid API key is essential for authorization to handle the request.
manualWebhookRequest ManualWebhookRequest DTO for webhook request.

Return type

DefaultOfstring

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json