Webhooks

The Pocket webhooks allow you to react to various events in real-time:

• Incoming purchases
• Payouts
• Identification requests
• Refunds

You'll receive these events for all orders you've created through the Pocket REST API v1.

Registration

Soon you'll be able to register your webhook endpoints by yourself. Until then, please contact us.

Webhook request

For each event you'll receive an HTTP request to every of your registered webhook endpoints.

The basic structure of these requests is as follows:

POST /webhook

Content-Type: application/json
User-Agent: Pocket-Webhook/1.0
X-Signature-256: 89cc7396704998f25bd0019bdc2ec30de78ff0c89add39685b30df608ba2a8d6
X-Correlation-Id: 7320abc0-c88f-4d72-b72c-deae658782e2
X-Retry-Count: 0

{
  "event": "event.action",
  "payload": {
    "some": "payload"
  }
}

Signature validation

It is highly recommended that you validate the X-Signature-256 header attached to every webhook request. It's the only way to confirm that the request originated from Pocket and thus its payload can be trusted.

The signature is created by calculating the HMAC-SHA256 of the request body using a shared secret key. You're free to choose a shared secret key during registration of your webhook endpoint.

The X-Signature-256 value is always prefixed with sha256=, so please prepend this prefix to your calculated signature before comparing.

See bitkipi/sig-tools for an example on how to calculate the signature.

Correlation header

We recommend you to log the X-Correlation-Id header while processing a webhook request. In case of an issue, this information allows us to precisely track the request up to its origin.

Error handling

Webhook delivieries are automatically retried on failure. Anything other than HTTP 2xx is considered a failed delivery and will lead to a retry in 5 minutes. That delay is doubled on every further attempt.

In the future you'll be able to list and resend single webhook events, for example after scheduled maintenance of your system. Until then, please contact us.

Event types

The request payload depends on the type of event being sent. These are the possible event types:

Event exchange.executed

Please note that in this event type the reason and payout fields are always null.

{
  "event": "exchange.executed",
  "payload": {
    "exchange_id": "a2d75998-5ee5-4501-a4cf-4e3788732b7a",
    "order_id": "64decab6-4129-4fe7-9f6e-1db68283f5ce",
    "fee_rate": 0.015,
    "pair": "btc/chf",
    "type": "buy",
    "cost": 100.00,
    "executed_on": "2021-09-15T14:35:10.122Z",
    "amount": 0.00197000,
    "rate": 50000.00,
    "fee": 1.50,
    "action": null,
    "reason": null,
    "payout": null
  }
}

Event exchange.interrupted

This event signals that an action is required to continue the exchange.

{
  "event": "exchange.interrupted",
  "payload": {
    "exchange_id": "a2d75998-5ee5-4501-a4cf-4e3788732b7a",
    "order_id": "64decab6-4129-4fe7-9f6e-1db68283f5ce",
    "fee_rate": 0.015,
    "pair": "btc/chf",
    "type": "buy",
    "cost": 100.00,
    "executed_on": "2021-09-15T14:35:10.122Z",
    "amount": 0.00197000,
    "rate": 50000.00,
    "fee": 1.50,
    "action": {
      "code": "initiate_payout",
      "payout_options": {
        // ...
      }
    },
    "reason": {
      "code": "payout_failure"
    },
    "payout": {
      // ...
    }
  }
}

Interruption reasons

There is only one possible code available:

• payout_failure - Indicates a payout failure. A detailed failure_code is included in the Payout object.

Interruption actions

The action needed to uninterrupt the exchange is provided in the action object.

There is only one possible code available:

• initiate_payout - Indicates that a payout_options needs to be selected.

{
  // ...
  "action": {
    "code": "initiate_payout",
    "payout_options": {
      "invoice": {
        "lnurl": "LNURL1DP68GURN8GHJ7UR0VD4K2ARPWPCZ6EMFWSKKCMN4WFKZ6CMGV9HXUETV94CX7CMTV46XZURS9EMX2UNRV4KZUCTSWQHKZURF9AKXUATJDSHHW6T5DPJ8YCTH9AJNJVPEXQCK2VFDX5UX2E3DXSEKGVFDVG6RJVFDXGEN2WPEXG6N2VE5XE3SS87AS5",
        "fee": 0,
        "expires_on": "2023-05-23T08:58:42.086Z"
      },
      "channel": {
        "lnurl": "LNURL1DP68GURN8GHJ7UR0VD4K2ARPWPCZ6EMFWSKKCMN4WFKZ6CMGV9HXUETV94CX7CMTV46XZURS9EMX2UNRV4KZUCTSWQHKZURF9AKXUATJDSHKX6RPDEHX2MP0V5UNQWFSX9JNZTF48PJKVTF5XDJRZTTZXSUNZTFJXV6NSWFJX56NXDPKVVRFMWRA",
        "fee": 10000,
        "expires_on": "2023-05-23T08:58:42.086Z"
      }
    }
  }
}

To request a lightning invoice payout the lnurl withdraw request protocol can be use. Alternatively the API client can send an invoice directly through the PATCH exchange endpoint. The provided invoice must contain the exchange amount minus the payout fee. (zero in this example)

To request a lightning channel payout the lnurl channel request protocol can be use. Alternatively the API client can initiate the channel payout though the PATCH exchange endpoint.

Once the offered fee has expired you have to request a new fee offer before requesting a payout. You can request a new offer by calling the GET exchange endpoint (only expired fee offers will be renewed).

Interruption payout

The payout details are provided in the payout object:

{
  "event": "exchange.interrupted",
  "payload": {
    // ...
    "payout": {
      "type": "invoice",
      "status": "failed",
      "failure_code": "no_route",
      // ...
    }
  }
}

There are multiple invoice payout failure_codes possible:

• no_route - no rout could be found.
• invoice_expired - the invoice expired.
• error - something went wrong, try again.

There are multiple channel payout failure_codes possible:

• min_chan_size - the receiving lightning node does allow such small channels.
• connect_error - connecting to the lightning node failed.
• push_amt_rejected - the receiving lightning node does not allow channel payouts.
• error - something went wrong, try again.

Event exchange.refunded

Please note that in this event type all execution details are empty, including action and payout, but the reason field is set.

{
  "event": "exchange.refunded",
  "payload": {
    "exchange_id": "a2d75998-5ee5-4501-a4cf-4e3788732b7a",
    "order_id": "64decab6-4129-4fe7-9f6e-1db68283f5ce",
    "fee_rate": 0.015,
    "pair": "btc/chf",
    "type": "buy",
    "cost": 100.00,
    "executed_on": null,
    "amount": null,
    "rate": null,
    "fee": null,
    "action": null,
    "reason": {
      "code": "threshold_exceeded"
    },
    "payout": null
  }
}

Refund reasons

The reason why an exchange is refunded is provided in the reason object:

{
  "reason": {
    "code": "threshold_exceeded"
  }
}

These are the possible reason codes:

• threshold_exceeded - A threshold was exceeded and the exchange could not be processed, e.g. due to lack of full identification.
• order_inactive - The order was set to inactive and cannot be used unless activated again.
• companies_unsupported - Payment arrived from a company bank account which is not yet supported.
• country_unsupported - Payment arrived from a country which is not yet supported.
• other_risk_detected - Some other risk was detected that prevents this exchange from being executed.
• customer_requested - The customer requested a refund of their payment.
• account_not_matching - Payment arrived from another person than the one associated with the order.
• payout_expired - The payout was not possible within the specified time window.

Event exchange.settled

Please note that in this event type the action and reason fields are always null.

{
  "event": "exchange.settled",
  "payload": {
    "exchange_id": "a2d75998-5ee5-4501-a4cf-4e3788732b7a",
    "order_id": "64decab6-4129-4fe7-9f6e-1db68283f5ce",
    "fee_rate": 0.015,
    "pair": "btc/chf",
    "type": "buy",
    "cost": 100.00,
    "executed_on": "2021-09-15T14:35:10.122Z",
    "amount": 0.00197000,
    "rate": 50000.00,
    "fee": 1.50,
    "action": null,
    "reason": null,
    "payout": {
      // details depending on payout type
    }
  }
}

In case of lightning invoice payouts this event is only sent once. For lightning payment channel payouts, the event is sent twice (channel funding and channel open). For bitcoin on-chain payouts this event will be set multiple times. First once the transaction is broadcast, then called again if the transaction was replaced and finally once the transaction is confirmed in the blockchain.

Settled coin payout

The payout details are provided in the payout object:

{
  "event": "exchange.settled",
  "payload": {
    // ...
    "payout": {
      "type": "coin",
      "txid": "c01c7a0fd270aa3876119098c0e2d51687a795efab99787e214d8a93ab9f8342",
      "outpoint": 1,
      "bitcoin_address": "bc1q5vvayqt3n4alhjaxy6ql4w2fs6r0y83rmvh3tg",
      "derivation_path": null,
      "block_height": null,
      "confirmations": 0,
      "fee": 0.00000190,
      "amount": 0.0019681
    }
  }
}

Settled invoice payout

The payout details are provided in the payout object:

{
  "event": "exchange.settled",
  "payload": {
    // ...
    "payout": {
      "type": "invoice",
      "status": "completed",
      "invoice": "lntb532230n1pj9y0jjpp5rvfx3xm8qldv4jv27h87z38dzr96kv5g2xz3nfhqqxpwetedfw3sdq5g9kxy7fqd9h8vmmfvdjscqzpgxqyz5vqsp5n00s9xjghllwpchkfwaxtufg0gy6w7vjwch27n29vg3j574tg50s9qyyssq7hmfgn963zptfgpjhkjese0kj794aavqjgzu9lrpa6wue08gryh3vclxcd6kr7f7v7k7g6akydrm8pk2uj3en77pecn7lh0776gvnnqq39466d",
      "preimage": "39b25d4a9dedc51239d3d67e0df41d265b87105c519ba2230c77362ab20e08c8",
      "fee": 0,
      "amount": 0.0053223
    }
  }
}

Settled channel payout

The payout details are provided in the payout object:

{
  "event": "exchange.settled",
  "payload": {
    // ...
    "payout": {
      "type": "channel",
      "status": "funding",
      "host": "34.65.45.157:9736",
      "txid": "d9390988deaeb25d29d8814c0e4a4efc1ed676485c15223ad23339f0d2db17ad",
      "outpoint": 1,
      "channel_id": null,
      "fee": 0,
      "amount": 0.0053223
    }
  }
}