API

TestNotification

A test notification to an application webhook subscription.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method Route SDK operation Returns
POST /applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications create OK

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

created, err := client.TestNotification(nil).Create(map[string]any{"client_key": "example", "subscription_id": "example"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(created)

Lua

Construct client as shown in the Lua setup, then call the operations:

local created, err = client:TestNotification():create({ client_key = "example", subscription_id = "example" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$created = $client->TestNotification()->create(["client_key" => "example", "subscription_id" => "example"]);

Python

Construct client as shown in the Python setup, then call the operations:

created = client.TestNotification().create({ "client_key": "example", "subscription_id": "example" })

Ruby

Construct client as shown in the Ruby setup, then call the operations:

created = client.TestNotification.create({ "client_key" => "example", "subscription_id" => "example" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const created = await client.TestNotification().create({ client_key: "example", subscription_id: "example" })

Fields

Field Type Required Description
created_at string No Timestamp of when the test notification was created.
delivery_id string No ID of the delivery that was queued for sending.

create

POST /applications/{clientKey}/subscriptions/{subscriptionId}/test-notifications

Operation ID: webhookApplicationSubscriptionTest.

Authentication: bearer token (ClientCredentialsToken).

Parameters

Parameter In Type Required Description
clientKey path string Yes Your application's client key.
subscriptionId path string (uuid) Yes UUID of the subscription.
X-External-Correlation-Id header string (uuid) No Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: OK

application/json

Property Type Required Description
[].created_at string (date-time) No Timestamp of when the test notification was created.
[].delivery_id string (uuid) No ID of the delivery that was queued for sending.
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.