Skip to main content
POST
/
api
/
webhooks
/
configs
Insert a new config
curl --request POST \
  --url http://localhost/api/webhooks/configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint": "https://example.com",
  "eventTypes": [
    "TYPE1",
    "TYPE2"
  ],
  "name": "customer_payment",
  "secret": "V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "endpoint": "https://example.com",
    "secret": "V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3",
    "eventTypes": [
      "TYPE1",
      "TYPE2"
    ],
    "active": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
endpoint
string
required
Example:

"https://example.com"

​
eventTypes
string[]
required
Example:
["TYPE1", "TYPE2"]
​
name
string
Example:

"customer_payment"

​
secret
string
Example:

"V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3"

Response

Config created successfully.

​
data
object
required