register webhook endpoint

POST

/v1/webhook-endpoints

curl --request POST \
  --url https://api.flowpayra.com/v1/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'X-Api-Key: <X-Api-Key>' \
  --header 'X-Nonce: <X-Nonce>' \
  --header 'X-Signature: <X-Signature>' \
  --header 'X-Timestamp: <X-Timestamp>' \
  --data '{ "url": "https://example.com", "event_types": [ "example" ] }'

Authorizations

• HmacApiKey
• HmacSignature
• HmacTimestamp
• HmacNonce

Parameters

Header Parameters

Idempotency-Key

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

object

url

required

string format: uri

<= 2048 characters

event_types

Array<string>

unique items

Example^generated

{
  "url": "https://example.com",
  "event_types": [
    "example"
  ]
}

Responses

200

Successful response

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

secret

required

string

>= 1 characters

event_types

required

Array<string>

Example^generated

{
  "id": "example",
  "secret": "example",
  "event_types": [
    "example"
  ]
}

400

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

401

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

404

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

409

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}

422

Stable API error

Media typeapplication/json

object

code

required

string

message

required

string

details

Example^generated

{
  "code": "example",
  "message": "example",
  "details": "example"
}