Skip to content

Fetch Webchat Blog Metadata

POST
/webchat/blogs/fetch-metadata

Read a page’s Open Graph metadata, to pre-fill an article card.

Fetches the URL and returns its og:title, og:description and og:image. PERSISTS NOTHING and spends nothing - create the card with POST /webchat/blogs afterwards.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A URL to read Open Graph metadata from.

Persists NOTHING. It fetches the page and returns its og:title, og:description and og:image so a caller can pre-fill an article card instead of typing it - which is why it is tiered a read despite the verb.

object
url
required

Page to read og:title / og:description / og:image from.

string
>= 1 characters <= 1000 characters

Responses

200

Successful Response

object
data
required

An open envelope for one webchat object.

Open because the widget’s config grows a field per product decision and a pinned schema would DROP it. Same choice the desk surface made.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string