Activate Blockchain Event Subscription

Through this endpoint customers can reactivate an event subscription (callback) which has been deactivated by the system. Deactivations could happen due to various reasons, most often "maximum retry attempts reached".

Single Result - This endpoint returns only one single result. POST /blockchain-events/subscriptions/{referenceId}/activate

Path Parameters

  • Required
    referenceId string

    Represents a unique ID used to reference the specific callback subscription.

    Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa

Query parameters

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

Request body schema application/json

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

  • Required
    data object
    • Required
      item object

Response schema

201 400 401 402 403 404 409 415 422 429 500
HTTP Status Code: 201
Content-Type: application/json

The resource has been successfully created.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0
  • Required
    requestId string

    Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : You can add any text here
  • Required
    data object
    • Required
      item object
      • Required
        address string

        Represents the address of the transaction, per which the result is returned.

        Example : 0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5
      • Required
        blockchain string

        Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

        Example : bitcoin
      • Required
        callbackSecretKey string

        Represents the Secret Key value provided by the customer. This field is used for security purposes during the callback notification, in order to prove the sender of the callback as Crypto APIs. For more information please see our Documentation.

        Example : yourSecretKey
      • Required
        callbackUrl string

        Represents the URL that is set by the customer where the callback will be received at. The callback notification will be received only if and when the event occurs.

        Example : http://example.com
      • Required
        confirmationsCount integer

        Represents the number of confirmations, i.e. the amount of blocks that have been built on top of this block.

        Example : 2
      • Required
        createdTimestamp integer

        Defines the specific time/date when the subscription was created in Unix Timestamp.

        Example : 1611238648
      • Required
        eventType string

        Defines the type of the specific event available for the customer to subscribe to for callback notification.

        Example : ADDRESS_TOKENS_TRANSACTION_CONFIRMED
      • Required
        isActive boolean

        Defines whether the subscription is active or not. Set as boolean.

        Example : True
      • Required
        network string

        Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.

        Example : testnet
      • Required
        referenceId string

        Represents a unique ID used to reference the specific callback subscription.

        Example : bc243c86-0902-4386-b30d-e6b30fa1f2aa
      • Required
        transactionId string

        Represents the unique identification string that defines the transaction.

        Example : 0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33

Credits Cost : 5 Credits For 1 Result(s)

Try it out

Request Example

POST
https://rest.cryptoapis.io/v2/blockchain-events/subscriptions/bc243c86-0902-4386-b30d-e6b30fa1f2aa/activate
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Request Body
{
    "context": "",
    "data": {
        "item": {}
    }
}

Response Example

{
    "apiVersion": "2.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "You can add any text here",
    "data": {
        "item": {
            "address": "0x7495fede000c8a3b77eeae09cf70fa94cd2d53f5",
            "blockchain": "bitcoin",
            "callbackSecretKey": "yourSecretKey",
            "callbackUrl": "http://example.com",
            "confirmationsCount": 2,
            "createdTimestamp": 1611238648,
            "eventType": "ADDRESS_TOKENS_TRANSACTION_CONFIRMED",
            "isActive": true,
            "network": "testnet",
            "referenceId": "bc243c86-0902-4386-b30d-e6b30fa1f2aa",
            "transactionId": "0xbe38781783b1b9d480219255ff98e20335a39e13979a66112efa33f05fde0a33"
        }
    }
}