Webhook Events Reference

This page provides details on the format of the Marketplace events sent by Manifold through webhooks. For information about how these events are sent, see the Webhooks Overview.

Publishing Headers

Manifold uses the following headers to identify itself and the published event:

  • X-Manifold-Event: The event type. Can be used to determine whether to process the event and how to unmarshal the payload.
  • X-Manifold-Request: A pseudo-random, unsigned, 64-bit value which identifies the request which publishes the event in Manifold’s system. Can be used for debugging purposes.
  • User-Agent: Identifies the publisher and publisher version. The publisher is always Manifold-Publisher/, followed by the publisher’s version. Can be used for debugging purposes.
  • Content-Type: The content type, always set to application/json.

Events

resource:provisioned

The Resource Provisioned event is triggered immediately after Manifold receives confirmation that a resource has been provisioned by a service provider and that Manifold has stored the resource’s credentials. This means that when you receive a resource provisioning event, credentials have been committed to our datastore.

Important: A resource can no longer be queried after the deprovisioning event has been sent. If you need to get information about a deprovisioned resource, you must have a stored reference to its ID.

The Resource Provisioned event contains the following data:

  • resource_id: The Manifold ID of the resource.
  • subject: The user identifier, as stored on your platform.

Example

A sample payload for a resource:provisioned event notification.

POST /payload HTTP/2
Host: platform.inc
X-Manifold-Request:2174322186382409630 
User-Agent: Manifold-Publisher/225.2019-08-11.13ee8e7
Content-Type: application/json
Content-Length: 94
X-Manifold-Event: resource:provisioned
{
    "event": "resource:provisioned",
    "version": 1,
    "data": {
        "resource_id": "268001x7xpph6y18u006zaq6ejy7m",
        "subject": "usr-bkb74nefgkcmr7043up0"
    }
}

resource:deprovisioned

The Resource Deprovisioned event is triggered immediately after Manifold removes the credentials from its datastore. Once you receive this event, decouple the resource’s configuration from your services. When a resource is deprovisioned, it’s deleted, so you won’t be able to query it through Manifold’s GraphQL API.

The Resource Deprovisioned event contains the following data:

  • resource_id: The Manifold ID of the resource.
  • subject: The user identifier, as stored on your platform.

Example

A sample payload for a resource:deprovisioned event notification.

POST /payload HTTP/2
Host: platform.inc
X-Manifold-Request: 2174322186382409630
User-Agent: Manifold-Publisher/225.2019-08-11.13ee8e7
Content-Type: application/json
Content-Length: 94
X-Manifold-Event: resource:deprovisioned
{
    "event": "resource:deprovision",
    "version": 1,
    "data": {
        "resource_id": "268001x7xpph6y18u006zaq6ejy7m",
        "subject": "usr-bkb74nefgkcmr7043up0"
    }
}