---
updatedAt: 2025-08-15T15:45:24.000Z
agentTools:
projectIndex: https://docs.arcadia.com/v1.0-Utility-Cloud/llms.txt
---
# Get all webhooks
Utility Cloud can send webhook events for any notable events for recurring requests. For example, this could include if a new statement is available or we notice a credential is now resulting in login failure.
This endpoint allows you to get a list of all the webhooks that are in the system. However, the system will not create any webhooks until your organization has configured a webhook URL. You can configure this using this endpoint or in Console via the _Configuration_ tab on the _My Account_ page accessible from the top right of the page.
Webhooks are deleted automatically after 30 days past their last send attempt date, except for Realtime Credential Validation (RTCV) webhooks, which are deleted immediately after successfully being delivered or after 3 failed send attempts. RTCV webhooks have `eventType` of either `LOGIN_SUCCESS` or `LOGIN_FAILURE` and may have a webhook URL different from the organization default if the credential was submitted via Connect.
Note that the webhook resources returned by this endpoint are not the same as the payload that is sent to the webhook URL. That payload is included in the `message` field as a JSON string in this resource which also includes more metadata about the webhook, such as the last and next send attempt times.
For more information on how webhooks work in Utility Cloud, see this page.
This endpoint is pageable; see here for more details.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Utility Cloud",
"description": "Utility Cloud",
"version": "2.0"
},
"servers": [
{
"url": "https://api.urjanet.com/"
}
],
"paths": {
"/utility/webhooks": {
"get": {
"tags": [
"Webhooks"
],
"summary": "Get all webhooks",
"description": "Utility Cloud can send webhook events for any notable events for recurring requests. For example, this could include if a new statement is available or we notice a credential is now resulting in login failure.\nThis endpoint allows you to get a list of all the webhooks that are in the system. However, the system will not create any webhooks until your organization has configured a webhook URL. You can configure this using this endpoint or in Console via the _Configuration_ tab on the _My Account_ page accessible from the top right of the page.\nWebhooks are deleted automatically after 30 days past their last send attempt date, except for Realtime Credential Validation (RTCV) webhooks, which are deleted immediately after successfully being delivered or after 3 failed send attempts. RTCV webhooks have `eventType` of either `LOGIN_SUCCESS` or `LOGIN_FAILURE` and may have a webhook URL different from the organization default if the credential was submitted via Connect.\nNote that the webhook resources returned by this endpoint are not the same as the payload that is sent to the webhook URL. That payload is included in the `message` field as a JSON string in this resource which also includes more metadata about the webhook, such as the last and next send attempt times.\nFor more information on how webhooks work in Utility Cloud, see this page.\nThis endpoint is pageable; see here for more details.",
"operationId": "List Webhooks",
"parameters": [
{
"name": "search",
"in": "query",
"description": "An RSQL query string (see here for details.)",
"schema": {
"type": "string"
}
},
{
"description": "Zero-based page index (0..N)",
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"default": 0
}
},
{
"description": "The size of the page to be returned",
"in": "query",
"name": "size",
"schema": {
"type": "integer",
"default": 20
}
},
{
"description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPublicWebhookResource"
}
},
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/PagedPublicWebhookResource"
}
}
}
}
},
"security": [
{
"BearerAuth": []
},
{
"UnifiedAuth": []
},
{
"APIKey": []
}
]
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-amazon-apigateway-api-key-source": "AUTHORIZER",
"x-amazon-apigateway-binary-media-types": [
"application/pdf",
"application/zip",
"application/octet-stream"
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"UnifiedAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-amazon-apigateway-authtype": "custom",
"x-amazon-apigateway-authorizer": {
"authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:291789168161:function:${stageVariables.authenticatorFunctionName}/invocations",
"authorizerCredentials": "arn:aws:iam::291789168161:role/${stageVariables.authenticatorRoleName}",
"authorizerResultTtlInSeconds": 300,
"type": "token"
}
},
"APIKey": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
}
},
"schemas": {
"PageMetadata": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int64"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int64"
}
},
"title": "PageMetadata"
},
"PagedPublicWebhookResource": {
"required": [
"_embedded",
"_links",
"page"
],
"properties": {
"_embedded": {
"properties": {
"webhooks": {
"items": {
"$ref": "#/components/schemas/PublicWebhookResource"
},
"type": "array"
}
},
"type": "object"
},
"_links": {
"properties": {
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"prev": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
},
"title": "PagedPublicWebhookResource",
"type": "object"
},
"PublicWebhookResource": {
"required": [
"createdBy",
"createdDate",
"eventType",
"entityId",
"lastAttemptedSend",
"lastModifiedBy",
"lastModifiedDate",
"lastSendHttpStatus",
"message",
"nextScheduledSend",
"numberOfAttempts",
"status",
"webhookUrl"
],
"properties": {
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"resend": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
},
"entityId": {
"type": "string",
"description": "The ID of the webhook"
},
"eventType": {
"type": "string",
"nullable": true,
"description": "The type of webhook. This field determines the structure of the payload contained in the message field.",
"enum": [
"NEW_STATEMENT",
"MODIFIED_STATEMENT",
"STATUS_CHANGE",
"DELETION_COMPLETE",
"LOGIN_SUCCESS",
"LOGIN_FAILURE"
]
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string",
"nullable": true
},
"lastModifiedDate": {
"type": "string",
"format": "date-time"
},
"lastModifiedBy": {
"type": "string"
},
"webhookUrl": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"WAITING_RESEND",
"ERROR",
"SUCCESS"
]
},
"numberOfAttempts": {
"type": "integer"
},
"lastAttemptSend": {
"nullable": true,
"type": "string",
"format": "date-time"
},
"lastSendHttpStatus": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nextScheduledSend": {
"nullable": true,
"type": "string",
"format": "date-time"
},
"message": {
"type": "string",
"description": "The body payload of the webhook as a JSON string"
}
},
"title": "PublicWebhookResource",
"type": "object"
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true,
"samples-enabled": true
}
}
```