Overview

The Webhooks API allows you to subscribe to events happening with your created objects (Invoices or Payouts) in Calypso. Rather than making an API call to check status of invoice or payout during processing, Calypso can send an HTTP request to an endpoint you configure. You can configure subscribed events using the endpoints detailed below.

How it works?

In order to receive notifications you should send a POST request to the create webhook endpoint where you should transmit URL where you want to receive POST requests with event data from Calypso and event types or group of event types for which you need to receive notifications.

Then when one of events for which you have subscription happens, Calypso sends a POST request to the configured URL with data about the event.

You can manage your subscription using the delete webhook endpoint and the change webhook endpoint.

There is the get list of webhook subscriptions endpoint in order to get information about events and URLs you have a subscription.

Retry policy

If the receiving party returned an error when sending the webhook to the configured URL, Calypso will be trying to resend the webhook. The first retry will be occured in 30 seconds. The next retries will be proceeded in Fibonacci sequence: 30 s, 60 s, 90 s, 150 s, 240 s and so on. The last period of retry is 125 430 s (~ 34 hours). The last webhook will try to be resent after 125 430 s and then will be stopped. There are 19 retries in total.

Blocking a webhook subscription

If your system cannot correctly process our webhooks, and we receive errors from you for the webhooks sent, we will be forced to block your subscription, blocking occurs if within 10 minutes we receive more than 100 errors from you and not one success.

You can unblock the subscription in your personal account, in the section for developers/webhooks Unblocking your subscription will automatically resend all webhooks for which we received an error from you during this period.