> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Ably

> Ably is a real-time messaging platform helping developers build live features, including chat and data synchronization, with global scalability and robust reliability for modern applications

![Ably logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/ably.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=88a5499eebbd392b1643450c4725a5b2)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 25
* **Triggers:** 0
* **Slug:** `ABLY`
* **Version:** 20261101\_00

## Tools

> [accordion] Query Batch Presence
>
> **Slug:** `ABLY_BATCH_PRESENCE`
>
> Queries the presence states of multiple Ably channels in a single request, retrieving member presence details for the specified channels. Channel names are separated by commas by default, with an optional alternative separator.
>
> #### Input Parameters
>
> **channels** `string` *required*
>
> Comma-separated list of channel names to query presence for
>
> **separator** `string`
>
> Character used to separate channel names (default is comma)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Query Batch Presence History
>
> **Slug:** `ABLY_BATCH_PRESENCE_HISTORY`
>
> Query presence history for multiple Ably channels, with optional start and end times and forwards or backwards ordering. Returns up to 100 messages per channel by default, with a limit of 1,000 per channel; channels not found are omitted.
>
> #### Input Parameters
>
> **end** `integer`
>
> End time in milliseconds since epoch
>
> **limit** `integer`
>
> Maximum number of messages to return per channel (default 100, max 1000)
>
> **start** `integer`
>
> Start time in milliseconds since epoch
>
> **channels** `array` *required*
>
> List of channel names to query presence history for
>
> **direction** `string`
>
> Direction of results (backwards or forwards)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Channel Subscription
>
> **Slug:** `ABLY_DELETE_CHANNEL_SUBSCRIPTION`
>
> Unsubscribes a device or client from push notifications for a specified channel, or across all channels if no channel is provided. Deletion is asynchronous, so subscriptions may briefly remain visible.
>
> #### Input Parameters
>
> **channel** `string`
>
> Optional channel name to filter subscriptions. If not provided, subscriptions across all channels for the specified device\_id or client\_id will be deleted.
>
> **client\_id** `string`
>
> Client ID to filter subscriptions. At least one of device\_id or client\_id must be provided. Cannot be used together with device\_id.
>
> **device\_id** `string`
>
> Device ID to filter subscriptions. At least one of device\_id or client\_id must be provided. Cannot be used together with client\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Channel Details
>
> **Slug:** `ABLY_GET_CHANNEL_DETAILS`
>
> Retrieves status and occupancy metadata for a specific Ably channel, including connection, presence, publisher, and subscriber metrics. The request can activate the channel and requires channel-metadata permission.
>
> #### Input Parameters
>
> **channel\_id** `string` *required*
>
> The ID of the channel to retrieve details for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Channel History
>
> **Slug:** `ABLY_GET_CHANNEL_HISTORY`
>
> Retrieves a page of message history for a specified Ably channel, with time range, limit, and direction filters. Results follow the requested direction, which defaults to backwards.
>
> #### Input Parameters
>
> **end** `integer`
>
> The end of the query interval as a time in milliseconds since the epoch
>
> **limit** `integer`
>
> The maximum number of records to return. A limit greater than 1,000 is invalid
>
> **start** `integer`
>
> The start of the query interval as a time in milliseconds since the epoch
>
> **direction** `string`
>
> The direction of this query. The direction determines the order of the returned result array
>
> **channel\_id** `string` *required*
>
> The ID of the channel to retrieve history for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Channel Presence
>
> **Slug:** `ABLY_GET_CHANNEL_PRESENCE`
>
> Tool to obtain the set of members currently present for a channel. Use when you need to check which clients are currently connected and active on a specific Ably channel.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of presence members to return. Default is 100.
>
> **format** `string ("json" | "jsonp" | "msgpack" | "html")`
>
> Response format enum.
>
> **clientId** `string`
>
> Filter presence members by client ID
>
> **channel\_id** `string` *required*
>
> The Channel's ID for which to retrieve presence information
>
> **connectionId** `string`
>
> Filter presence members by connection ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Message Versions
>
> **Slug:** `ABLY_GET_MESSAGE_VERSIONS`
>
> Retrieves a page of historical versions of a specific Ably channel message, including the original and subsequent updates or deletes. Versions may include timestamps, action types, and client IDs.
>
> #### Input Parameters
>
> **serial** `string` *required*
>
> The message serial identifier (format: timestamp-counter\@connectionId:counter)
>
> **channel\_id** `string` *required*
>
> The ID of the channel containing the message
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Channel Presence History
>
> **Slug:** `ABLY_GET_PRESENCE_HISTORY`
>
> This tool retrieves the history of presence messages for a specified channel in Ably. It allows you to query presence events on a channel within a given time period.
>
> #### Input Parameters
>
> **end** `integer`
>
> The end of the query interval as a time in milliseconds since the epoch. Defaults to current time.
>
> **limit** `integer`
>
> The maximum number of records to return. Maximum value is 1000.
>
> **start** `integer`
>
> The start of the query interval as a time in milliseconds since the epoch
>
> **direction** `string`
>
> The direction of results. Can be either 'backwards' or 'forwards'.
>
> **channel\_id** `string` *required*
>
> The channel name to get presence history for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Push Device Registration
>
> **Slug:** `ABLY_GET_PUSH_DEVICE`
>
> Retrieves a device's push registration by device ID, including available platform, state, recipient, and metadata fields.
>
> #### Input Parameters
>
> **format** `string ("json" | "jsonp" | "msgpack" | "html")`
>
> Response format options for the API
>
> **device\_id** `string` *required*
>
> Device's ID. Unique identifier for the device registration.
>
> **X\_Ably\_Version** `string`
>
> The version of the API you wish to use. If not specified, the default version will be used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Ably Service Time
>
> **Slug:** `ABLY_GET_SERVICE_TIME`
>
> This tool retrieves the current server time from Ably's service in milliseconds since the epoch. It is particularly useful for time synchronization and generating valid TokenRequest timestamps to prevent replay attacks. The endpoint supports multiple content types, handles HTTP errors, network issues, and is a fundamental tool for ensuring accurate timing in Ably applications.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Application Stats
>
> **Slug:** `ABLY_GET_STATS`
>
> Retrieve a page of Ably application usage statistics by minute, hour, day or month, with optional time range, direction and limit. Results can include message, connection, channel, API request, push and token request metrics; pagination links are not returned.
>
> #### Input Parameters
>
> **end** `integer`
>
> Latest time in milliseconds since epoch for stats retrieval. Times are rounded down based on the unit parameter. If omitted, defaults to current time
>
> **unit** `string`
>
> Time interval granularity for stats aggregation. Must be 'minute', 'hour', 'day', or 'month'. Defaults to 'minute'
>
> **limit** `integer`
>
> Maximum number of stats records to return (1-1000). Defaults to 100. Use with pagination for larger datasets
>
> **start** `integer`
>
> Earliest time in milliseconds since epoch for stats retrieval. Times are rounded down based on the unit parameter. If omitted, stats are retrieved from the beginning of available data
>
> **direction** `string`
>
> Query direction determining result order. 'backwards' returns newest first (default), 'forwards' returns oldest first
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Channels
>
> **Slug:** `ABLY_LIST_CHANNELS`
>
> Tool to enumerate all active channels in the Ably application. Use when you need to discover available channels or monitor channel activity. Returns paginated results and is heavily rate-limited. Can return either channel names only or full channel details with occupancy data.
>
> #### Input Parameters
>
> **by** `string ("id" | "value")`
>
> Channel enumeration options.
>
> **limit** `integer`
>
> Maximum number of channels to return. Default is 100, maximum is 1000.
>
> **format** `string ("json" | "jsonp" | "msgpack" | "html")`
>
> Response format options for the API.
>
> **prefix** `string`
>
> Filter to return only channels whose name starts with the given prefix
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Push Channels
>
> **Slug:** `ABLY_LIST_PUSH_CHANNELS`
>
> Lists a page of Ably channels with at least one subscribed device for push notifications.
>
> #### Input Parameters
>
> **format** `string ("json" | "jsonp" | "msgpack" | "html")`
>
> Response format enum for Ably API.
>
> **x\_ably\_version** `string`
>
> The version of the Ably API you wish to use. When not specified, the default API version is used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Push Channel Subscriptions
>
> **Slug:** `ABLY_LIST_PUSH_CHANNEL_SUBSCRIPTIONS`
>
> Lists a page of push channel subscriptions filtered by channel, client ID, or device ID, with pagination links; at least one filter is required. Client and device filters can be combined when concat filters is enabled.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of records to return. Maximum value is 1000.
>
> **channel** `string`
>
> Filter to restrict to subscriptions associated with that channel. At least one of channel, client\_id, or device\_id must be specified.
>
> **client\_id** `string`
>
> Filter to restrict to subscriptions associated with that clientId. Cannot be used with device\_id unless concat\_filters is True. At least one of channel, client\_id, or device\_id must be specified.
>
> **device\_id** `string`
>
> Filter to restrict to subscriptions for that deviceId. Cannot be used with client\_id unless concat\_filters is True. At least one of channel, client\_id, or device\_id must be specified.
>
> **concat\_filters** `boolean`
>
> When set to true, allows combining client\_id and device\_id filters to find all subscriptions matching either filter
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Registered Push Devices
>
> **Slug:** `ABLY_LIST_REGISTERED_PUSH_DEVICES`
>
> List a page of Ably push device registrations, optionally filtered by device ID or client ID. Returns available pagination links; the limit controls page size.
>
> #### Input Parameters
>
> **limit** `integer`
>
> The maximum number of records to return. Default is 100, maximum is 1000
>
> **format** `string ("json" | "jsonp" | "msgpack" | "html")`
>
> Response format options.
>
> **clientId** `string`
>
> Optional filter to restrict to devices associated with that clientId
>
> **deviceId** `string`
>
> Optional filter to restrict to devices associated with that deviceId
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Push Device Registration
>
> **Slug:** `ABLY_PATCH_PUSH_DEVICE_REGISTRATION`
>
> Partially update an existing Ably push device registration. Ably permits changes to client ID, metadata and push recipient; supplied structured values replace rather than merge with existing values.
>
> #### Input Parameters
>
> **id** `string`
>
> Unique identifier for the device generated by the device itself
>
> **format** `string`
>
> The response format you would like (json, jsonp, msgpack, html)
>
> **clientId** `string`
>
> Optional trusted client identifier for the device
>
> **deviceId** `string` *required*
>
> Device's ID - the unique identifier for the device to update
>
> **metadata** `object`
>
> Optional metadata object for this device. The metadata for a device may only be set by clients with push-admin privileges and will be used more extensively in the future with smart notifications
>
> **platform** `string ("ios" | "android" | "browser")`
>
> Enum for platform types.
>
> **pushState** `string ("Active" | "Failing" | "Failed")`
>
> Enum for push state.
>
> **formFactor** `string ("phone" | "tablet" | "desktop" | "tv" | "watch" | "car" | "embedded")`
>
> Enum for form factor types.
>
> **deviceSecret** `string`
>
> Secret value for the device
>
> **xAblyVersion** `string`
>
> The version of the API you wish to use
>
> **pushRecipient** `object`
>
> Model for push recipient details.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Publish Messages
>
> **Slug:** `ABLY_PUBLISH_BATCH_MESSAGES`
>
> Tool to batch publish messages to multiple channels in parallel. Use when you need to send the same set of messages to multiple channels simultaneously for efficient broadcasting.
>
> #### Input Parameters
>
> **channels** `array` *required*
>
> Array of channel names to publish messages to. Maximum 100 channels.
>
> **messages** `array` *required*
>
> Array of messages to publish. Maximum 1000 messages.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish Message to Channel
>
> **Slug:** `ABLY_PUBLISH_MESSAGE_TO_CHANNEL`
>
> Publishes a message to a specified Ably channel with a string or JSON object payload and an optional event name and client ID. An optional message ID can be used for idempotent publishing. The result includes the channel and message ID.
>
> #### Input Parameters
>
> **client\_id** `string`
>
> Optional client identifier to associate with the message.
>
> **channel\_id** `string` *required*
>
> The name of the channel to publish the message to.
>
> **event\_name** `string`
>
> Optional event name/type for the message.
>
> **message\_id** `string`
>
> Optional unique message ID for idempotent publishing.
>
> **message\_data** `string` *required*
>
> The message payload. Can be a string or a JSON object.
>
> **push\_notification** `object`
>
> Optional push notification configuration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish Push Notification
>
> **Slug:** `ABLY_PUBLISH_PUSH_NOTIFICATION`
>
> Tool to publish a push notification directly to device(s) via Ably's Push Notifications API. Use when you need to send push notifications to specific devices identified by device ID, client ID, or platform-specific tokens. The API returns HTTP 204 on success with no response body.
>
> #### Input Parameters
>
> **push** `object`
>
> Push notification payload details.
>
> **recipient** `object` *required*
>
> Push recipient details for a device. Must specify at least one identifier (client\_id, device\_id, device\_token, or registration\_token).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Publish Push Notifications
>
> **Slug:** `ABLY_PUBLISH_PUSH_NOTIFICATIONS_BATCH`
>
> Tool to batch publish push notifications directly to specific recipients. Use when you need to send multiple push notifications efficiently in a single request. Supports up to 10,000 notifications per batch.
>
> #### Input Parameters
>
> **items** `array` *required*
>
> Array of push notification items to publish. Maximum 10,000 notifications per request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Register Push Device
>
> **Slug:** `ABLY_REGISTER_PUSH_DEVICE`
>
> Register an iOS, Android, or browser device with Ably to receive push notifications. Provide the device details and push recipient information; a successful registration returns the registered device's details.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier for the device generated by the device itself. This is a client-generated ID that uniquely identifies the device.
>
> **metadata** `object`
>
> Optional metadata object for this device. The metadata may only be set by clients with push-admin privileges and will be used for smart notifications.
>
> **platform** `string ("ios" | "android" | "browser")` *required*
>
> Platform of the push device. Must be one of: ios, android, or browser.
>
> **client\_id** `string`
>
> Optional trusted client identifier for the device. Used to associate the device with a specific client in your Ably app.
>
> **push\_state** `string ("Active" | "Failing" | "Failed")`
>
> State types for push devices.
>
> **form\_factor** `string ("phone" | "tablet" | "desktop" | "tv" | "watch" | "car" | "embedded")` *required*
>
> Form factor of the push device. Must be one of: phone, tablet, desktop, tv, watch, car, or embedded.
>
> **device\_secret** `string`
>
> Secret value for the device. Used for device authentication.
>
> **push\_recipient** `object` *required*
>
> Push recipient details for the device. Contains transport type and platform-specific configuration like device tokens or web push endpoints.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Request Access Token
>
> **Slug:** `ABLY_REQUEST_ACCESS_TOKEN`
>
> Request an Ably access token with optional capabilities, client ID and lifetime. If capability is omitted, the request asks for full wildcard access.
>
> #### Input Parameters
>
> **ttl** `integer`
>
> Time-to-live for the token in milliseconds. Defaults to 60 minutes (3600000ms) if not specified.
>
> **nonce** `string`
>
> Random nonce string for token request uniqueness. Prevents replay attacks. If not provided, Ably generates one.
>
> **key\_name** `string` *required*
>
> The key name comprises of the app ID and key ID of an API key. Format: appId.keyId (e.g., 'rLhKFg.1Hf06Q')
>
> **client\_id** `string`
>
> Optional client identifier to associate with this token. When set, the token can only be used by the specified client ID.
>
> **timestamp** `integer`
>
> Token request timestamp in milliseconds since epoch. If not provided, Ably will use the current server time. Used for token request validation.
>
> **capability** `string`
>
> JSON-stringified capability text specifying permissions. Use '\{"*":\["*"]}' for full access, or specify specific channels and operations. Must be a valid JSON string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unregister All Push Devices
>
> **Slug:** `ABLY_UNREGISTER_ALL_PUSH_DEVICES`
>
> Unregister matching Ably push devices, optionally filtering by device ID or client ID, but not both. Their push channel subscriptions are also deleted; removal is asynchronous.
>
> #### Input Parameters
>
> **client\_id** `string`
>
> Optional filter to restrict to devices associated with that clientId. Cannot be used with device\_id.
>
> **device\_id** `string`
>
> Optional filter to restrict to devices associated with that deviceId. Cannot be used with client\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unregister Push Device
>
> **Slug:** `ABLY_UNREGISTER_PUSH_DEVICE`
>
> Unregister a single Ably push device by device ID. Its push channel subscriptions are also deleted; removal is asynchronous.
>
> #### Input Parameters
>
> **format** `string ("json" | "jsonp" | "msgpack" | "html")`
>
> Enum for response format options
>
> **device\_id** `string` *required*
>
> The unique identifier of the device to unregister from push notifications. This is the device ID that was used when the device was originally registered.
>
> **X-Ably-Version** `string`
>
> The version of the Ably API you wish to use. Example: '1.2'
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Push Device Registration
>
> **Slug:** `ABLY_UPDATE_PUSH_DEVICE`
>
> Upsert an Ably push device registration, creating it or replacing an existing registration. Existing registrations are largely immutable: client ID, metadata, and push recipient are updatable, while changes to other fields may fail.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier for the device generated by the device itself. This should match device\_id.
>
> **metadata** `object`
>
> Optional metadata object for this device. May only be set by clients with push-admin privileges.
>
> **platform** `string ("ios" | "android" | "browser")` *required*
>
> Platform of the push device (ios, android, or browser).
>
> **client\_id** `string`
>
> Optional trusted client identifier for the device.
>
> **device\_id** `string` *required*
>
> Device's ID. This is the unique identifier for the device being registered/updated.
>
> **push\_state** `string ("Active" | "Failing" | "Failed")`
>
> Push device state types.
>
> **form\_factor** `string ("phone" | "tablet" | "desktop" | "tv" | "watch" | "car" | "embedded")` *required*
>
> Form factor of the push device (phone, tablet, desktop, tv, watch, car, or embedded).
>
> **device\_secret** `string`
>
> Secret value for the device.
>
> **push\_recipient** `object` *required*
>
> Push recipient details for the device, including transport type and device/registration tokens.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
