Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Links

Create link

Create a link. You must supply either pattern or external_url in the request, but not both (pattern is for application objects while external_url is for standard links). If pattern is provided, the API call updates the application objects matching the exact pattern. Keep in mind this endpoint only creates or updates an existing link from an application object. It does not create new application objects. If the link is resolved to an installed links integration, any name retrieved from the integration will override the provided name in the request.

Required scope: links:write

post/links

Request body

namestring

Name of the link. If none is specified, the external_url is used as a default

external_urlstring

Underlying identifying url of the link

patternstring

The string that application object configurations will match on to update a specific application object. For example, if you've configured an application object to match on ORDER-{Digits}, and you want to specifically update the application objects for ORDER-777 to retrieve the latest information from external systems, send "ORDER-777". Repeat for other specific identifiers, such as "ORDER-435".

Example request

{
  "pattern": "ORDER-123"
}

Response

A link

idstring required

Unique identifier of the link

namestring required

Display name of the link

typestring required

Type of the link. Typically associated with the underlying link provider (if known)

external_urlstring required

Underlying identifying external URL of the link

custom_fieldsCustomFieldParameter required

An object whose key is the name property defined for the custom field in the Front UI. The value of the key must use the same type specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/links/top_b2wpa"
  },
  "id": "top_b2wpa",
  "name": "JIRA-SCRAN-4567",
  "type": "app_2f76b9ac738de158",
  "external_url": "https://dundermifflin.atlassian.net/browse/PB-SCRAN-4567",
  "custom_fields": {
    "city": "London, UK",
    "isVIP": true,
    "renewal_date": 1525417200,
    "sla_time": 90,
    "owner": "leela@planet-express.com",
    "replyTo": "inb_55c8c149",
    "Job Title": "firefighter"
  }
}