Skip to content

get webhook endpoint

GET
/v1/webhook-endpoints/{id}
curl --request GET \
--url https://api.flowpayra.com/v1/webhook-endpoints/example \
--header 'X-Api-Key: <X-Api-Key>' \
--header 'X-Nonce: <X-Nonce>' \
--header 'X-Signature: <X-Signature>' \
--header 'X-Timestamp: <X-Timestamp>'
id
required
string
>= 1 characters <= 128 characters

Successful response

Media typeapplication/json
object
id
required
string
>= 1 characters <= 128 characters
url
required
string format: uri
event_types
required
Array<string>
active
required
boolean
created_at
required
string format: date-time
Examplegenerated
{
"id": "example",
"url": "https://example.com",
"event_types": [
"example"
],
"active": true,
"created_at": "2026-04-15T12:00:00Z"
}

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
"code": "example",
"message": "example",
"details": "example"
}

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
"code": "example",
"message": "example",
"details": "example"
}

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
"code": "example",
"message": "example",
"details": "example"
}

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
"code": "example",
"message": "example",
"details": "example"
}

Stable API error

Media typeapplication/json
object
code
required
string
message
required
string
details
Examplegenerated
{
"code": "example",
"message": "example",
"details": "example"
}