Source
Integrations & API — found from sitemap — Unblu
Checked for Unblu on 27 Oct 2026
- Page
- https://docs.unblu.com/latest/knowledge-base/integration/web-api-webhooks/web-api.html
- Checked
- 27 Oct 2026, 05:13 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:faca86fb85082a5ede1af99780d8fff3bfccfd6b4e30a2704810e8d9782ae3d6
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Web API overview Report an error
“The Unblu web API provides an HTTP-based interface that allows other systems to perform actions on the Unblu server. It supports many of the same actions accessible through the conventional user interfaces. This enables the integration of Unblu with third-party applications.”
-
Webhooks overview Report an error
“Unblu webhooks enable integration in the reverse direction. They allow you to configure the Unblu server to react to internal events by triggering an HTTP request to an external system.”
-
Web API crud Report an error
“The Unblu web API exposes all the major entities that make up the internal data model of the Unblu server and offers methods to create, read, update and delete these entities via HTTP GET and POST requests.”
-
Entity types Report an error
“Examples of entity types include user, team, conversation and account.”
-
API versions Report an error
“Unblu 8 supports API v2, v3, and v4. v2 and v3 have been deprecated and are only provided for reasons of backward compatibility.”
-
Authentication mechanisms Report an error
“There are three mechanisms available for authentication with the Unblu web API: basic authentication, authentication with API secrets, and the Authenticator Service.”
-
User roles Report an error
“The permission level in Unblu is defined by the client’s role: ANONYMOUS_USER, WEB_USER, REGISTERED_USER, SUPERVISOR, ADMIN, TECHNICAL_ADMIN, or SUPER_ADMIN”
-
Entry paths Report an error
“Unblu has two entry paths that are relevant in the context of the web API: the INTERNAL and the PUBLIC entry paths. The default INTERNAL path prefix is app, and the default PUBLIC path prefix is unblu.”
-
No patch syntax Report an error
“Keep in mind that the API doesn’t support patch syntax. In other words, you can’t specify only the properties that you want to change on a write.”
-
Optimistic locking Report an error
“The version has been incremented. This is a mechanism used to avoid concurrent update conflicts.”
-
Search endpoints Report an error
“The Unblu web API provides a search endpoint for many of the entities it exposes. The endpoint expects a POST HTTP request with the search criteria specified in the request body.”
-
Search operators Report an error
“CONTAINS Checks if the value contains the string provided in the operator EQUALS Checks if the value is equal to the one provided in the operator NOT_EQUALS”
-
Pagination Report an error
“The offset and limit can be used to paginate search results.”
-
Expand parameter Report an error
“The expand query parameter allows you to specify that one or more properties in an object are to be represented in fully expanded form, not just as IDs.”
-
Secret masking Report an error
“If you make a read request with the expand=configuration query parameter, and the entity you requested includes a configuration property of the type SECRET or MULTILINE_SECRET, the value of the configuration property will be masked.”
-
Java library Report an error
“Since the release of Unblu 7.18.2, the Java libraries containing the web API models and the Jersey client are available on Maven Central and GitHub.”
-
Openapi spec Report an error
“Additionally, the Unblu web API specification is available in the Open API format to allow for easier integration with third party software.”
-
Openapi location Report an error
“<unblu-server>/rest/v2/openapi <unblu-server>/rest/v3/openapi”
-
Server bundled docs Report an error
“The same information is also served from your installed Unblu server and can be found at <unblu-server>/unblu/servicesdocumentation.”
-
Webhook config Report an error
“Unblu webhooks can be configured either via the Account Configuration interface or the WebhookRegistrations endpoints of the Unblu web API.”
-
Webhook event groups Report an error
“Agent invitation and forwarding events Events related to the creation, revocation and redemption of invitations sent to agents, or of forwarding of a conversation to an agent.”
-
Webhook crud entities Report an error
“Events triggered when an entity is edited. The entities that can trigger such events are: account API key domain named area person team user”
-
Cloud hostname Report an error
“For the Unblu Cloud, this is always unblu.cloud.”
-
Hosting regions note Report an error
“In the Unblu Cloud, the entry path prefix configuration is fixed to the default values.”
-
Basic auth warning Report an error
“If you make calls to web API endpoints from the browser, you shouldn’t use basic authentication.”
Scores citing this record
- The Agent Advocate Integrations & API
- The Data Protection Officer Integrations & API
- The Shop Operator Integrations & API
- The Integrator Customer data protection
- The Integrator Integrations & API
- The Skeptic Integrations & API
- The Support Lead Integrations & API