List effects
GET/effects●Query effects with filtering, sorting, and pagination.
Use this endpoint to review configured event subscriptions, identify which effects are listening for a specific signal, or audit event routing configuration across your ledger.
Supported filters:
data.schema— effect schemameta.status— record statusmeta.labels— record labelsmeta.domain— domain scopedata.custom.<field>— any custom field (may be slower on large datasets)
Usage Examples
curl -X GET "http://localhost:3000/v2/effects" \ -H "x-ledger: <YOUR LEDGER HANDLE>"{
"hash": "86b784a2deaef26f37f8485391fc1c203d7cab7ff86cc8c6184b590aa82617da",
"data": [
{
"luid": "$eff.-01xK5vWxY6hW8AB7",
"hash": "92a858f132198ba17f4e9bafbfd2fa55f521236cb4780e2cb335f02c29840d55",
"data": {
"handle": "intent-created",
"signal": "intent-created",
"action": {
"bridge": "tesla-bank-bridge"
}
},
"meta": {
"status": "created",
"moment": "2025-04-05T14:30:00.050Z",
"owners": [
"dsZvr0rEw9sIffHlv1VP65x1NB8GeXezIv6HONk1SIk="
],
"proofs": [
{
"signer": "tesla-bank-admin",
"method": "ed25519-v2",
"digest": "4002631f636059f68e31bc8e517f026daf592ec6f9cf2a311af1b89048b58802",
"public": "dsZvr0rEw9sIffHlv1VP65x1NB8GeXezIv6HONk1SIk=",
"result": "jUI71kR80f3uIRrj2oaot+k7STGxmibE6YTIx42OxaFKgKvaOw7d1JSxIp2Qf488czdt9hurVzgElOpnZb2qBA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z",
"status": "created"
}
},
{
"signer": "system",
"method": "ed25519-v2",
"digest": "b90e717212ccaea9f46c7bae5206905daaa67f3b5f0f9ef058dae036955c0276",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "7WaxRr3Uff7fxLs+I0wlc/htE5OwyMIi4ahIIq7p3ZG2itgBT9O+Gxqk46Zjf6HeKB1GjLjQXWMmndxMSFyvCQ==",
"custom": {
"luid": "$eff.-01xK5vWxY6hW8AB7",
"moment": "2025-04-05T14:30:00.050Z",
"status": "created"
}
}
]
}
},
{
"luid": "$eff.-01xG73A7vhGG9BC7",
"hash": "12e9361954aec5d5bd05b2aa1d1ecbfcb8bc393253b5e9aed155089c738ea3d2",
"data": {
"handle": "wallet-created",
"parent": "92a858f132198ba17f4e9bafbfd2fa55f521236cb4780e2cb335f02c29840d55",
"signal": "wallet-created",
"filter": {
"wallet.data.schema": "bank"
},
"action": {
"bridge": "nova-bank-bridge"
}
},
"meta": {
"status": "created",
"moment": "2025-04-05T14:21:40.025Z",
"owners": [
"i90xMpGuWFGxnnKRX/7slzF/vH+1XW2UcAl/e7kUKa0="
],
"proofs": [
{
"signer": "nova-bank-admin",
"method": "ed25519-v2",
"digest": "990b0b20403417ded3d03b6fc1424c9e73c4a4a080f5aebf294944eb81ff461d",
"public": "i90xMpGuWFGxnnKRX/7slzF/vH+1XW2UcAl/e7kUKa0=",
"result": "TQ115Pc0SEotTpi4b7C0q/AXhYuJoxJdyJ9kWS8JESpSFLoxyQWmUcn5Rjjf7fXggX1FTKObrk3yTvN9FwiGDg==",
"custom": {
"moment": "2025-04-05T14:21:40.000Z",
"status": "created"
}
},
{
"signer": "system",
"method": "ed25519-v2",
"digest": "4e565bba038067fcfd2726fe6f1b4c409e91abbd89af9cd8844ae0ed76e52e36",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "NITCeTw8aGJgkodAfAhyUe/azTIrYyxpoAsd2e2KrGT0WLpTHio+j+4NZBCo/yTbXZNeOYaF6IjspZV1ZYFFCg==",
"custom": {
"luid": "$eff.-01xG73A7vhGG9BC7",
"moment": "2025-04-05T14:21:40.025Z",
"status": "created"
}
}
]
}
}
],
"page": {
"index": 0,
"limit": 20
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "e6d5a89f1a0dd0a81c0039751651fa26e4d462f92f45302231d6a9b6c9466849",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "bqxQSOI8Efy4iP0vqn89AZkq0EXNCb/2iLLvKWD+H+2CZhcRHzP9zoox7SQzRdiBOr+kd3iV1+oRHpTR8mNIBQ==",
"custom": {
"moment": "2025-04-05T14:30:00.100Z"
}
}
]
}
}{
"hash": "b7eb7ccf5ffc126951e13e29a8dcfdaf95db859715d4edfc2d16f59a79d4cd58",
"data": {
"reason": "auth.unauthorized",
"detail": "Invalid token."
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "3acece870c4118bfe4223118e4d2f3cfd5b8947a7093785b66d49aa57fa2890a",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "gnK63DqqWDY/UXvnZHixDKPKS6tfeGHgdARylnPiJLwQGyYxuD97TYbSg2wrzsf/bDrHwQYZaf8Gu5ryYP0UAA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "9ec02726b50650add8acfd124c6defeb978a9ac252a5de888f9493ddc701e927",
"data": {
"reason": "auth.forbidden",
"detail": "Request is not authorized"
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "4f8cbdc38d73348de0c31805c783c84a0fecc6be736d7e187004ba68cd00e675",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "P3hRnveehtuobb4AIO56XBmiduvmYJbpdmOHltG/IifBEH7QSWdv/0pqled4SO9x1Ne3oXuWxJy40DzMvx1MBA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "bd1e78b47e837376b7994e3e481aa547c110c4d6a1c1d8ecd047cc465edd33bd",
"data": {
"reason": "api.request-timeout",
"detail": "Processing of request on server timed out. Your request may or may not have been processed."
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "cdf5b09c809ec52934cd76ca3b0aa59310049e3cae8b171aee3cf9e0f98bddb2",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "6h1lhq3TOccWrfIdtOa9pkz9pIHVAN9tyXuNaucvLpbspWACog6HpSAdr0FSwGzn0zAKwx8YppGOVjFhfeBLBw==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "1c084e8dcfb9bb84bc8ea96e9e137b149a34b2bbd85f8e60b4263f5aba980476",
"data": {
"custom": {
"errors": [
{
"instancePath": "/handle",
"schemaPath": "#/properties/handle/pattern",
"keyword": "pattern",
"params": {
"pattern": "^[a-zA-Z0-9_\\-+.]+$"
},
"message": "must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
}
]
},
"reason": "record.schema-invalid",
"detail": "Schema validator error: data.handle must match pattern \"^[a-zA-Z0-9_\\-+.]+$\""
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "7a5febb431719b6f43d7e88e79211308e16ac651b71b339276373fdb4e7c3760",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "2/1zYw4AaIzsIHfOIC6V/CHw6owbjYHt48cwmFOig0ibeT0IbojLmj1RCRi8W00ka0udPa9WsacWDd7ObMY8CA==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}{
"hash": "93a5f4d97a42c2df97f827c58ff7768d02568c15aca931e22b81fa3160ba0df3",
"data": {
"reason": "api.unexpected-error",
"detail": "An unexpected error occurred"
},
"meta": {
"proofs": [
{
"signer": "system",
"method": "ed25519-v2",
"digest": "efaf5360143b586917d9636779ad6e08571c5b06909a20dd0f5eba4bf3be7eae",
"public": "bctQzN7mjMUNBIx4aSC8WYn03GJWoJjL/KrDb38oU5c=",
"result": "hERh6Aecj59iR+Fb25OQsHJScOi4t8EiffKSfjlMQdjHMccTnfDlgZFdaJzXzUtpSwy/NHq0l+7ydh3HSWCoAg==",
"custom": {
"moment": "2025-04-05T14:30:00.000Z"
}
}
]
}
}Query Parameters
page?
Pagination options. Set limit and index to page through results.
filter?
Filter by field values using dot notation (e.g. data.handle=value). Operators like $in and $regex are optional — equality is the default.
Header Parameters
x-ledger?|
The unique identifier of ledger in context for multi tenant requests.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
Create effect POST
The effect begins delivering events immediately after creation. Each event matching the declared signal and optional filter is delivered asynchronously to the configured endpoint. Delivery actions include `webhook` for direct HTTP delivery and `bridge` to route events through a bridge's security and retry mechanisms. Failed deliveries are retried automatically with exponential backoff. Filters use a MongoDB-style query syntax on the event data, allowing granular control over which events trigger delivery. Broadcasts the `effect-created` signal.
Get effect GET
Next Page