v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-054815267.9 KB
SyncV1Service

post/v1/Services

Response

Created

sidstring nullable

The unique string that we created to identify the Service resource.

unique_namestring nullable

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource. It is a read-only property, it cannot be assigned using REST API.

account_sidstring nullable

The SID of the Account that created the Service resource.

friendly_namestring nullable

The string that you assigned to describe the resource.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updatedstring date-time nullable

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

urlstring uri nullable

The absolute URL of the Service resource.

webhook_urlstring uri nullable

The URL we call when Sync objects are manipulated.

webhooks_from_rest_enabledboolean nullable

Whether the Service instance should call webhook_url when the REST API is used to update Sync objects. The default is false.

reachability_webhooks_enabledboolean nullable

Whether the service instance calls webhook_url when client endpoints connect to Sync. The default is false.

acl_enabledboolean nullable

Whether token identities in the Service must be granted access to Sync objects by using the Permissions resource. It is disabled (false) by default.

reachability_debouncing_enabledboolean nullable

Whether every endpoint_disconnected event should occur after a configurable delay. The default is false, where the endpoint_disconnected event occurs immediately after disconnection. When true, intervening reconnections can prevent the endpoint_disconnected event.

reachability_debouncing_windowinteger

The reachability event delay in milliseconds if reachability_debouncing_enabled = true. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before webhook_url is called, if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the reachability event from occurring.

linksobject nullable

The URLs of related resources.