Skip to main content
API docs by Redocly

Rabo Smart Pay Webhook Subscriptions Management API (0.0.1)

Download OpenAPI specification:Download

Webhooks

List all available webhook event types.

List all available webhook event types.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Subscriptions

List all webhook subscriptions.

List all webhook subscriptions.

Responses

Response samples

Content type
application/json
{
  • "subscriptions": [
    ]
}

Create a new webhook subscription

A webhook subscription consist of a status, an url, and a set of eventTypes.

header Parameters
idempotency-key
string [ 1 .. 64 ]
Example: ce55fab6b56d45279f90b3d2152e7766

Idempotency key used to safely retry the request.

Request Body schema: application/json
required
status
required
string
Enum: "enabled" "disabled"

Status of the subscription. Indicates wheter or not Rabo Smart Pay will deliver to this subscription or not.

Options are enabled, and disabled.

url
required
string <uri>

URL of the subscription. Events for this subscription will be delivered to this URL.

It is important that your server, at the receiving end of this URL, is set up correctly to accept events.

description
string [ 1 .. 2048 ]

Optional description that you provide to this subscription.

Will be used when listing subscriptions.

eventTypes
required
Array of strings (EventType) non-empty
Items Enum: "test/v1" "order.finalized/v1"

Set of event types that are delivered using this subscription.

A subscription is not allowed to have no event types associated with it, at least one must be configured.

Responses

Request samples

Content type
application/json
{
  • "status": "enabled",
  • "url": "http://example.com",
  • "description": "string",
  • "eventTypes": [
    ]
}

Get details of an existing webhook subscription

Get details of an existing webhook subscription.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "enabled",
  • "url": "http://example.com",
  • "description": "string",
  • "eventTypes": [
    ]
}

Update an existing webhook subscription

Updating a webhook subscription. Only values specified in the request will be updated.

If a subscription gets disabled, and it still has active deliveries, or retries pending, Rabo Smart Pay will still deliver those even though the subscription is disabled.

Keep in mind that your server might still receive events on the disabled subscription!

Request Body schema: application/json
required
status
string
Enum: "enabled" "disabled"

Status of the subscription. Indicates wheter or not Rabo Smart Pay will deliver to this subscription or not.

Options are enabled, and disabled.

url
string <uri>

URL of the subscription. Events for this subscription will be delivered to this URL.

It is important that your server, at the receiving end of this URL, is set up correctly to accept events.

description
string [ 1 .. 2048 ]

Optional description that you provide to this subscription.

Will be used when listing subscriptions.

eventTypes
Array of strings (EventType) non-empty
Items Enum: "test/v1" "order.finalized/v1"

Set of event types that are delivered using this subscription.

A subscription is not allowed to have no event types associated with it, at least one must be configured.

Responses

Request samples

Content type
application/json
{
  • "status": "enabled",
  • "url": "http://example.com",
  • "description": "string",
  • "eventTypes": [
    ]
}

Delete an existing webhook subscription

Delete an existing webhook.

If the subscription still has active deliveries, or retries pending, Rabo Smart Pay will still deliver those even though the subscription is deleted.

Keep in mind that your server might still receive events on the deleted subscription!

Responses

Verifications

Verify webhook subscription by sending a test event

Verify webhook subscription by sending a test event.

Responses