Retrieve webhook endpoint

GET

webhook_endpoints

{uuid}

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid}"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "uuid": "6f1d3c2a-9b8e-4a7d-b5c4-1e2f3a4b5c6d",
  "url": "https://erp.example.com/webhooks/streamlined",
  "description": "ERP deposit sync",
  "events": [
    "deposit_link.paid",
    "deposit_link.payment_failed"
  ],
  "status": "enabled",
  "disabled_reason": null,
  "last_success_at": "2026-09-10T16:04:12Z",
  "last_failure_at": null,
  "created_at": "2026-09-10T15:00:00Z"
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

uuid

string

required

Response

Successful operation

uuid

string

url

string

description

string | null

events

string[]

status

enum<string>

Available options:

enabled,

disabled

disabled_reason

string | null

Why the endpoint switched itself off. Null while enabled.

last_success_at

string<date-time> | null

last_failure_at

string<date-time> | null

created_at

string<date-time>

⌘I

Retrieve webhook endpoint

curl --request GET \
  --url https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid} \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>'

const options = {method: 'GET', headers: {'X-App-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid}"

headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/webhook_endpoints/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "uuid": "6f1d3c2a-9b8e-4a7d-b5c4-1e2f3a4b5c6d",
  "url": "https://erp.example.com/webhooks/streamlined",
  "description": "ERP deposit sync",
  "events": [
    "deposit_link.paid",
    "deposit_link.payment_failed"
  ],
  "status": "enabled",
  "disabled_reason": null,
  "last_success_at": "2026-09-10T16:04:12Z",
  "last_failure_at": null,
  "created_at": "2026-09-10T15:00:00Z"
}

Orders

Customers

Customer applications

Customer groups

Customer files

Customer addresses

Payouts

Invoices

Transactions

Products

Deposit links

Webhooks

Retrieve webhook endpoint

Authorizations

Path Parameters

Response