InvestiFiPartner APIBeta
Prod Environment
Webhooks

Create Webhook Subscription

Create a webhook subscription, issuing the financial institution's signing secret on first use. The signing secret is returned only when this subscribe issued it (the financial institution's first subscription); on later subscribes it already exists and is omitted.

Parameters
body
The event type and callback URL to subscribe.
api_key
Resolved Partner API key, providing the financial institution scope for the subscription.
Returns

The created subscription, with the signing secret when first issued.

Raises
HTTPException
400 Bad Request when the callback URL fails validation.
https://partner-api.investifi.com/v1
POST
/webhooks/subscriptions

Authorization

APIKeyHeader
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://partner-api.investifi.com/v1/webhooks/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "event_type": "kyc",    "url": "string"  }'
{
  "subscription_id": "string",
  "event_type": "kyc",
  "url": "string",
  "signing_secret": "string",
  "created_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Webhook Subscriptions

Returns the financial institution's active webhook subscriptions. Disabled (unsubscribed) subscriptions are hidden, so a subscription a partner has deleted does not reappear in the list.

Delete Webhook Subscription

Unsubscribe by disabling the subscription so delivery stops. Soft-disable: the record is kept with `enabled=False` and `disabled_at` set. Disabling an already-disabled subscription is a no-op and still returns 204 No Content, so unsubscribe is idempotent.