Webhooks

Returns the list of webhooks.

get

The webhooks are sorted by creation date, with the most recent webhook appearing first.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/webhooks' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

401

500

200

[
  {
    "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
    "url": "https://example.com",
    "createdAt": "2024-12-03T10:07:54.940Z",
    "updatedAt": "2024-12-03T10:07:54.940Z"
  }
]

A JSON array of webhooks.

Creates a webhook.

post

Creates a webhook with the specified URL. A webhook secret is generated and returned in the response. It is used to sign the webhook payloads.

Authorizations

Body

urlstring · urirequired

The URL of the webhook.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/webhooks' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com"
  }'

201

400

401

500

201

{
  "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
  "url": "https://example.com",
  "secret": "a1b2c3d4e5",
  "createdAt": "2024-12-03T10:07:54.940Z",
  "updatedAt": "2024-12-03T10:07:54.940Z"
}

The webhook has been created.

Returns a webhook by ID.

get

Returns a webhook by its unique identifier.

Authorizations

Path parameters

webhookIdstring · uuidrequired

The unique identifier of the webhook.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/webhooks/{webhookId}' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

200

401

404

500

200

{
  "id": "9c0306d5-e18e-4689-93da-997e2cdc16e7",
  "url": "https://example.com",
  "createdAt": "2024-12-03T10:07:54.940Z",
  "updatedAt": "2024-12-03T10:07:54.940Z"
}

A webhook.

Deletes a webhook by ID.

delete

Deletes a webhook by its unique identifier.

Authorizations

Path parameters

webhookIdstring · uuidrequired

The unique identifier of the webhook.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.rialtobridge.xyz/api/manager/v1/webhooks/{webhookId}' \
  --header 'RIALTO_API_KEY: YOUR_API_KEY'

204

401

404

500

204

No body

The webhook has been deleted.