Skip to content
Pipevest Developers

Configuration and Payload

Planned — on our roadmap. Signed outbound webhooks and public-key retrieval are not yet enabled. Until they ship, learn a payment outcome by polling payment status. If webhooks are part of your integration plan, contact us.

Requirements

Section titled “Requirements”

Define Webook Url

  1. Webhook urls must be a valid HTTPS url
  2. The host of the url must be a DNS name and not an IP address

Determine Event Subscriptions

Decide which event subscriptions are appropriate for your use case.

Configuration Request

Section titled “Configuration Request”

Make a POST request to the /webhook to create and configure a webhook.

Terminal window
  curl --request POST \
    --url https://api.pipevest.com/v1/webhooks \
    --header 'Authorization: Bearer 123456' \
    --header 'Content-Digest: sha-512=:RK/0qy18MlBSVnWgjwz6lZEWjP/lF5HF9bvEF8FabDg=:' \
    --header 'Content-Type: application/json' \
    --header 'Signature: sig1=:OTEyMjY4...A5NTNDMEQ=:' \
    --header 'Signature-Input: sig1=("content-type" "content-digest" "content-length" "authorization" "x-client-id" "x-idempotency-key" "@method" "@target-uri" "@path" "@query");keyid="staging-pipevest-ed25519";created=1732893484;expires=1732893584' \
    --header 'X-Client-Id: 123456' \
    --header 'X-Idempotency-Key: 123456' \
    ...
    --data '{"url": "https://companyx.com/webhooks", "subscriptions": ["ACCOUNT", "CUSTOMER.UPDATED", "TRANSACTION"]}'

Configuration Side Effects

Section titled “Configuration Side Effects”

Successfully, configuring a webhook will have the following additional results:

  1. Automatic subscription to WEBHOOK.CREATED 💡 Learn More

  2. Cryptographic public key generated. 💡 Learn More

Webhook Payload

Section titled “Webhook Payload”

The webhook payload is composed of the following:

Name Definition
eventId Unique event identifier. Should be used to deduplicate potentially duplicate events
event The event type. Example: ACCOUNT
createdAt Unix timestamp of when the event was created
data The data associated with the event

Example Payload

Section titled “Example Payload”

In the example below, an account was been created within the system.

{
  "eventId": "c00ec5f3-bbf7-4284-9e2f-88d886f5068c",
  "event": "ACCOUNT.CREATED",
  "createdAt": 1732893584,
  "data": {
    "accountId": 123456,
    "customerId": 123456,
    "status": "ACTIVE",
    "investmentType": "INTERNATIONAL_STOCKS",
    "currency": "ZMW",
    "createdAt": 1732893584,
    "updatedAt": 1732893584
  }
}