Create a Subscription

Create a subscription for a transaction or monitored resource

Creates a subscription to receive status updates for a transaction created in Overledger, or to receive updates each time a transaction happens on the requested DLT for a resource (e.g. address) being monitored, to the requested callback URL. Subscriptions are created using an Overledger Transaction ID or Resource Monitoring ID

SecurityOAuth2_Security_Scheme
Request
header Parameters
Authorization
required
string [ 0 .. 5010 ] characters ^Bearer [A-Za-z0-9\-_. ]{1,5010}$
Request Body schema: application/json
ids
Array of strings [ 0 .. 36 ] items
callbackUrl
string [ 0 .. 300 ] characters ^http[\S\s]{1,300}$
type
string [ 0 .. 50 ] characters ^[a-zA-Z0-9-_ ]{1,50}$
Responses
200

All good!

400

Something went wrong on your side

401

Unauthorised

404

{id} does not exist

500

Something went wrong on our side

post/v2/webhook/subscription
Request samples
application/json

Create Subscription

{}
Response samples
application/json

Create Subscription

[
  • {
    }
]