Skip to main content
POST
/
webhooks
Creates a webhook configuration
curl --request POST \
  --url https://api.pipevest.com/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Digest: <content-digest>' \
  --header 'Content-Type: application/json' \
  --header 'Signature: <signature>' \
  --header 'Signature-Input: <signature-input>' \
  --header 'X-Client-Id: <x-client-id>' \
  --header 'X-Idempotency-Id: <x-idempotency-id>' \
  --data '{
  "url": "https://companyx.com/webhooks",
  "subscriptions": [
    "ALL"
  ]
}'
{
  "data": {
    "webhookId": 123456,
    "status": "ACTIVE",
    "url": "https://companyx.com/webhooks",
    "subscriptions": [
      "ALL"
    ],
    "createdAt": 1234567890,
    "updatedAt": 1234567890
  },
  "code": 201,
  "message": "Created"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Signature
string
required

Base64 encoded signed hash of the http message request components.

Learn how signatures work

Example:

"sig1=:OTEyMjY4...A5NTNDMEQ=:"

​
Signature-Input
string
required

An ordered list of components that make up the signature base. It is used to recompute and verify the Signature

Learn how signatures work

Example:

"sig1=(\"Content-Type\" \"Content-Digest\"...expires=<expires>"

​
X-Client-Id
string
required

Unique identifier assigned to the client

Example:

"client-id"

​
Content-Digest
string
required

Base64 encoded sha-512 hash of the http message body.

This key isn't not required for GET and DELETE requests.

Learn how to generate content digest

Example:

"sha-512=:RK/0qy18MlBSVnWgjwz6lZEWjP/lF5HF9bvEF8FabDg=:"

​
X-Idempotency-Id
string
required

Unique identifier passed into each a mutable request (i.e POST, PUT, PATCH, DELETE)

This key isn't not required for GET requests

Example:

"01937261-e216-754f-99ba-c1170d65dd28"

Body

application/json

Details used to create a webhook config

​
url
string
required

A valid https url

Example:

"https://companyx.com/webhooks"

​
subscriptions
enum<string>[]
required

Refer to Webhook documentation to understand how subscriptions work.

Response

Details of a created webhook

​
data
object
required
​
code
string
required

Request response code

Example:

201

​
message
string
required

Request response message

Example:

"Created"