Okpal API documentation

Work in progress, temporary hosted here


Webhooks allow project owners to receive notifications about events happening on the Okpal platform.

When an event occurs, for example when a contribution succeeds, Okpal creates an Event object. This object contains all the relevant information, including the type of event and the URI of the resource associated with that event.

Okpal then sends the Event object in the body of an HTTP POST request to the registered callback URL of a project.

Event object

An event object typically looks like the following:

    "created": "2015-09-01T16:40:05.805422",
    "object": "event",
    "resource": {
        "type": "contribution",
        "uri": "https://api.okpal.com/v1/contributions/53423"
    "type": "contribution.succeeded"

Configuring a server to receive webhooks

Configuring a server to receive webhooks is very close to creating a new page on a website.

With PHP, you might create a new .php file on your server. With a framework like Flask, you would add a new route with the desired URL.

Remember, with webhooks, your server is the server receiving the request.

Webhooks reference

Event type Description Resource type
contribution.succeeded Occurs when a contribution succeeded contribution
subscription.canceled Occurs when a subscription is canceled subscription
subscription.failed Occurs when a subscription failed subscription
subscription.succeeded Occurs when a subscription succeeded subscription