Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
240 lines (188 sloc) 7.81 KB
title
Endpoints

Endpoints

List All Webhooks

The webhooks resource returns all enabled and disabled webhooks. There is thus no need to store all active webhooks client side; as the node maintains a register for you.

Endpoint

GET /api/webhooks

Query Parameters

Name Type Description Required
page int The number of the page that will be returned. No
limit int The number of resources per page. No

Response

{
  "meta": {
    "count": 29,
    "pageCount": 1,
    "totalCount": 29,
    "next": null,
    "previous": null,
    "self": "/api/v2/webhooks?page=1&limit=100",
    "first": "/api/v2/webhooks?page=1&limit=100",
    "last": "/api/v2/webhooks?page=1&limit=100"
  },
  "data": [
    {
      "id": "4b255244-a535-4aca-aa92-9ff9e02c98dd",
      "event": "block.forged",
      "target": "https://httpbin.org/post",
      "enabled": true,
      "conditions": [
        {
          "key": "generatorPublicKey",
          "condition": "eq",
          "value": "032fcfd19f0e095bf46bd3ada87e283720c405249b1be1a70bad1d5f20095a8515"
        }
      ]
    }
  ]
}

Retrieve a Webhook

It is possible to query for a specific webhook by ID, which has to be saved client-side or obtained from another API call.

Endpoint

GET /api/webhooks/{id}

Path Parameters

Name Type Description Required
id string The identifier of the webhook to be retrieved. Yes

Response

{
  "data": {
    "id": "4b255244-a535-4aca-aa92-9ff9e02c98dd",
    "event": "block.forged",
    "target": "https://httpbin.org/post",
    "enabled": true,
    "conditions": [
      {
        "key": "generatorPublicKey",
        "condition": "eq",
        "value": "032fcfd19f0e095bf46bd3ada87e283720c405249b1be1a70bad1d5f20095a8515"
      }
    ]
  }
}

Create a Webhook

It is recommended to have a backend service running that will handle your webhook calls, as you'll have to provide a target value when creating the webhook. To give you an idea of how this works, we created a couple of example setups that you can use or get inspiration from. A webhook may be triggered by multiple conditions; as long as one of the conditions evaluates to true, the webhook will fire.

The returned token should be saved and used to validate the webhook origin. It is a secret value which should not be shared. For extra security, whitelist the IP of the node with your target service, ensuring other parties are not able to post webhook payloads.

The conditions lists consists of an array of objects, with the following properties:

  • key: the key used on the object that is passed along with the specified event
  • condition: a condition used to check the value against
  • value: (Optional) a value used to check the key against. This is not needed for the falsy and truthy conditions. In case of between and not-between, you'll have to provide an object like this: "value": { "min": "someValue", "max": "someValue" }

Endpoint

POST /api/webhooks

Body Parameters

Name Type Description Required
event string The name of the event to be listened for. Yes
target string The target URL for the HTTP payload. Yes
enabled string The value to enable or disable the webhook. No
conditions array The list of conditions required to trigger the webhook. Yes

Response

{
  "data": {
    "id": "4b255244-a535-4aca-aa92-9ff9e02c98dd",
    "event": "block.forged",
    "target": "https://httpbin.org/post",
    "token": "7e66949f67b36c34a05eeb3a866957b3f1b6f8947fb215500b78e5091d4e484a",
    "enabled": true,
    "conditions": [
      {
        "key": "generatorPublicKey",
        "condition": "eq",
        "value": "032fcfd19f0e095bf46bd3ada87e283720c405249b1be1a70bad1d5f20095a8515"
      }
    ]
  }
}

Events

Event Description Implemented
block.applied Fires when a block is saved Yes
block.disregarded Fires when a block is disregarded Yes
block.forged Fires when a block is forged Yes
block.received Fires when a block is incoming Yes
block.reverted Fires when a block is removed from the database (e.g. on a rollback) Yes
delegate.registered Fires when a new delegate is registered Yes
delegate.resigned Fires when a delegate resigns Yes
forger.failed Fires when the forger module fails to start Yes
forger.missing Fires when it is detected that the forger module isn't running Yes
forger.started Fires when the forger module forges a new block No
peer.added Fires when a peer is added Yes
peer.removed Fires when a peer is removed Yes
round.created Fires when a new round is created and saved to the database Yes
state:started No
transaction.applied Fires when a transaction is saved Yes
transaction.expired Fires when an unconfirmed transaction expires Yes
transaction.forged Fires when a transaction is forged by a delegate Yes
transaction.pool.added Fires when transactions are added to the transaction pool Yes
transaction.pool.rejected Fires when transactions are rejected and not added to the transaction pool Yes
transaction.pool.removed Fires when a transaction is removed from the transaction pool by its ID Yes
transaction.reverted Fires when a transaction is removed from the database No
wallet.saved Fires when a wallet is updated (e.g. its balance changed, voted etc) Yes
wallet.created.cold Fires when a wallet that never existed before is saved (e.g. received its first tx) Yes

Conditions

Condition Description
between Check if the given value is between min and max
contains Check if A contains B
eq Check if A equals B
falsy Check if the given value is false
gt Check if A is greater than B
gte Check if A is greater than or equal to B
lt Check if A is lesser than B
lte Check if A is lesser than or equal to B
ne Check if A does not equal B
not-between Check if the given value is not between min and max
regexp Check if the given value matches
truthy Check if the given value is true

Update a Webhook

Existing webhooks may be updated. Note that this is the equivalent of deleting and creating a webhook; but retaining the same token. If you are often updating and creating webhooks; consider deleting and creating new webhooks instead of updating to rotate your validation token often.

Endpoint

PUT /api/webhooks/{id}

Path Parameters

Name Type Description Required
id string The identifier of the webhook to be updated. Yes

Body Parameters

Name Type Description Required
event string The name of the event to be listened for. No
target string The target URL for the HTTP payload. No
enabled string The value to enable or disable the webhook. No
conditions array The list of conditions required to trigger the webhook. No

Response

HTTP/1.1 204 No Content
{}

Delete a Webhook

A webhook may be deleted by ID. Delete unused webhooks to save machine resources.

Endpoint

DELETE /api/webhooks/{id}

Path Parameters

Name Type Description Required
id string The identifier of the webhook to be deleted. Yes

Response

HTTP/1.1 204 No Content
{}
You can’t perform that action at this time.