Skip to content

Test a configuration against its provider

POST
/v1/integrations/{provider}/connections/{connection_id}/instances/{instance_id}/test
curl --request POST \
--url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test

A notification configuration sends a sample message, so an operator can confirm it reaches the right destination. A failed delivery is an error.

An agent-context configuration runs each operation it enables once, the same way the agents call it, and reports one result for each operation. Each operation searches for the connection’s name, and an answer with no results passes. A failed operation reports a fixed reason, never the provider’s response.

A rejected credential counts toward the connection’s authentication failures. Other capabilities have no test.

provider
required
string

Provider slug

connection_id
required
string format: uuid

Connection identifier

instance_id
required
string format: uuid

Configuration identifier

The test ran; agent-context results for each enabled operation

Media typeapplication/json

The result of a configuration test.

object
operations
required

One entry for each operation an agent-context configuration enables, in catalog order. Empty for a notification test, which reports a failed delivery as an error response.

Array<object>

The result of one operation in an agent-context test.

object
operation
required

The operation name, for example search_tickets.

string
reason

Why the operation failed, as a fixed reason. It never contains the provider’s response. Present when the operation failed.

string | null
results

How many results the provider returned. Present when the provider answered; an answer with no results passes.

integer | null

Example generated

{
"operations": [
{
"operation": "example",
"reason": "example",
"results": 1
}
]
}

The configuration has no test, is not active, or the provider rejected the delivery

Unknown provider, connection, or configuration