Overview

Use Webhooks to be notified of events in the Manifest platform. Note: Currently, Manifest supports one webhook per event, per environment.

Structure

When receiving a webhook notification, there will be an event and id fields:

{
    "event": "account_connection.update",
    "id": "acon_XXXXX",
    "timestamp": 1644893096,
    "user_data": {}
}

Validation (Optional)

Validating that webhooks originate from Manifest ensures that a webhook notification is authentic. If a webhook object has been created with the basic_user or basic_secret fields, notifications from Manifest will include an additional Authorization header that is the base64-encoded value of {basic_user}:{basic_secret}. When the base64 header matches the value your application expects, the request is authentic.

Example Header

Authorization: Basic YmVzdXJldG86ZHJpbmt5b3Vyb3ZhbHRpbmU=

Methods

Create
Get
List
Delete

POST /webhook
Subscribe to a type of event.

Body Parameters

url

string

required

The HTTPS URL where the event notification will be sent.

event

string

required

Event to subscribe to. See below for a list of available events.

basic_user

string

First value in base64(basic_user:basic_secret), sent as Authorization for request validation. This field will not appear in responses.

basic_secret

string

Second value in base64(basic_user:basic_secret), sent as Authorization for request validation. This field will not appear in responses.

user_data

object

User defined data that can be attached to the object. See the User Data page for details.

Example

// POST /webhook
{
    "url": "https://app.yoursite.com/webhook",
    "event": "payout.update"
}

{
    "id": "wh_XXXXX",
    "url": "https://app.yoursite.com/webhook",
    "event": "payout.update"
}

GET /webhook/:id
Get details of one of your webhooks.

Path Parameters

string

required

The ID of the webhook to retrieve.

Example

{
    "id": "wh_XXXXX",
    "url": "https://app.yoursite.com/webhook",
    "event": "payout.update"
}

GET /webhook
List all webhooks associated with your enterprise.

Query Parameters

page

integer

The page number to return. Default is 1.

page_size

integer

The number of items to return per page. Default is 10.

Example

{
    "data": [
        {
            "id": "wh_XXXXX",
            "url": "https://app.yoursite.com/webhook",
            "event": "payout.update"
        },
        {
            "id": "wh_YYYYY",
            "url": "https://app.yoursite.com/webhook",
            "event": "account_connection.update"
        },
    ],
    "pagination": {
        "page": 1,
        "page_size": 10,
        "total": 2
    }
}

DELETE /webhook/:id
Remove one of your webhooks.

Path Parameters

string

required

The ID of the webhook to delete.

Properties

string

Identifier for this webhook.

url

string

The HTTPS URL where the event notification will be sent.

event

string

Event to subscribe to. Possible values are:

account_connection.update
payout.update
buyer.update
purchase.update
contract.update

basic_user

string

First value in base64(basic_user:basic_secret), sent as Authorization for request validation. This field will not appear in responses.

basic_secret

string

Second value in base64(basic_user:basic_secret), sent as Authorization for request validation. This field will not appear in responses.

user_data

object

User defined data that can be attached to the object. See the User Data section for details.

​Overview

​Structure

​Validation (Optional)

​Methods

​Body Parameters

​Example

​Path Parameters

​Example

​Query Parameters

​Example

​Path Parameters

​Properties

Overview

Structure

Validation (Optional)

Methods

Body Parameters

Example

Path Parameters

Example

Query Parameters

Example

Path Parameters

Properties