Webhooks

Returns the list of webhooks.

get

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/webhooks

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

Authorizations

api_key

RIALTO_API_KEYstringRequired

Responses

200

A JSON array of webhooks.

application/json

401

Invalid API key

500

An unexpected error occurred.

get

/webhooks

HTTPcURLJavaScriptPython

GET /api/manager/v1/webhooks HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

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

Creates a webhook.

post

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/webhooks

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

api_key

RIALTO_API_KEYstringRequired

Body

application/json

urlstring · uriRequired

The URL of the webhook.

Responses

201

The webhook has been created.

application/json

400

The request is invalid.

application/json

401

Invalid API key

500

An unexpected error occurred.

post

/webhooks

HTTPcURLJavaScriptPython

POST /api/manager/v1/webhooks HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "url": "https://example.com"
}

{
  "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"
}

Returns a webhook by ID.

get

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/webhooks/{webhookId}

Returns a webhook by its unique identifier.

Authorizations

api_key

RIALTO_API_KEYstringRequired

Path parameters

webhookIdstring · uuidRequired

The unique identifier of the webhook.

Responses

200

A webhook.

application/json

401

Invalid API key

404

Webhook not found.

500

An unexpected error occurred.

get

/webhooks/{webhookId}

HTTPcURLJavaScriptPython

GET /api/manager/v1/webhooks/{webhookId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

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

Deletes a webhook by ID.

delete

https://api.rialtobridge.xyz/api/manager/v1https://staging.api.rialtobridge.xyz/api/manager/v1http://localhost:3002/api/manager/v1

/webhooks/{webhookId}

Deletes a webhook by its unique identifier.

Authorizations

api_key

RIALTO_API_KEYstringRequired

Path parameters

webhookIdstring · uuidRequired

The unique identifier of the webhook.

Responses

204

The webhook has been deleted.

401

Invalid API key

404

Webhook not found.

500

An unexpected error occurred.

delete

/webhooks/{webhookId}

HTTPcURLJavaScriptPython

DELETE /api/manager/v1/webhooks/{webhookId} HTTP/1.1
Host: api.rialtobridge.xyz
RIALTO_API_KEY: YOUR_API_KEY
Accept: */*

No content