External Content Sources

Use this API to define and manage external content sources. A source refers to the origin of the content records. Examples: forum, issue tracker, learning management system. Because end users can filter help center search results by content source, use descriptive names to help them understand and navigate your content.

For more information on federated search, see Introduction and Setting up Zendesk Federated Search in your help center in Zendesk help.

JSON format

Sources are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
created_at	string	false	false	ISO-8601 compliant date-time reflecting the time the event was created. If not set, the API sets the value when it receives the event
id	string	true	false	Universally Unique Lexicographically Sortable Identifier. See https://github.com/ulid/spec
name	string	false	true	The name of the source to be displayed in the help center
updated_at	string	false	false	ISO-8601 compliant date-time reflecting the time the event was last updated

List External Content Sources

• GET /api/v2/guide/external_content/sources

Returns a list of the external content sources created for this account.

Allowed For

• Help Center managers

Parameters

Name	Type	In	Required	Description
page	object	Query	false	Paginate query

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/sources \
  -v -u {email_address}:{password}

Example response(s)

200 OK

// Status 200 OK

{
  "meta": {
    "after_cursor": "MG",
    "before_cursor": "MQ",
    "has_more": true
  },
  "sources": [
    {
      "created_at": "2020-05-01T09:12:20Z",
      "id": "01E77R4513SKX3AE8H20Q0KJ1K",
      "name": "My Library",
      "updated_at": "2020-05-26T09:11:30Z"
    }
  ]
}

Show External Content Source

• GET /api/v2/guide/external_content/sources/{id}

Gets the specified external source.

Allowed For

• Help Center managers

Parameters

Name	Type	In	Required	Description
id	string	Path	true	A unique identifier for the source

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/sources/{id} \
  -v -u {email_address}:{password}

Example response(s)

200 OK

// Status 200 OK

{
  "source": {
    "created_at": "2020-05-01T09:12:20Z",
    "id": "01E77R4513SKX3AE8H20Q0KJ1K",
    "name": "My Library",
    "updated_at": "2020-05-26T09:11:30Z"
  }
}

Create External Content Source

• POST /api/v2/guide/external_content/sources

Creates an external content source.

Allowed For

• Help Center managers

Parameters

Name	Type	In	Required	Description
page	object	Query	false	Paginate query

Example body

{
  "source": {
    "name": "My Library"
  }
}

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/sources \
  -d '{"source": { "name": "My Library" }}' \
  -H "Content-Type: application/json" \
  -u {email_address}:{password} -X POST

Example response(s)

201 Created

// Status 201 Created

{
  "source": {
    "created_at": "2020-05-01T09:12:20Z",
    "id": "01E77R4513SKX3AE8H20Q0KJ1K",
    "name": "My Library",
    "updated_at": "2020-05-26T09:11:30Z"
  }
}

Update External Content Source

• PUT /api/v2/guide/external_content/sources/{id}

Updates the specified external content source with the request body.

Allowed For

• Help Center managers

Parameters

Name	Type	In	Required	Description
id	string	Path	true	A unique identifier for the source

Example body

{
  "source": {
    "name": "My Library"
  }
}

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/sources/{id} \
  -d '{"source": { "name": "My Library" }}' \
  -H "Content-Type: application/json" \
  -v -u {email_address}:{password} -X PUT

Example response(s)

200 OK

// Status 200 OK

{
  "source": {
    "created_at": "2020-05-01T09:12:20Z",
    "id": "01E77R4513SKX3AE8H20Q0KJ1K",
    "name": "My Library",
    "updated_at": "2020-05-26T09:11:30Z"
  }
}

Delete External Content Source.

• DELETE /api/v2/guide/external_content/sources/{id}

Deletes an external content source. Will also delete any crawler or record associated with this source.

Allowed For

• Help Center managers

Parameters

Name	Type	In	Required	Description
id	string	Path	true	A unique identifier for the source

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/external_content/sources/{id} \
  -v -u {email_address}:{password} -X DELETE

Example response(s)

204 No Content

// Status 204 No Content

null