Identities
Resource Fields
| Name | Type | Read-only | Description |
|---|---|---|---|
| facebook_id | string | ||
| user_name | string | ||
| full_name | string | ||
| string | |||
| bio | string | ||
| birth_date | timestamp | ISO-8601 Format | |
| website | string | ||
| profile_url | string | ||
| locale | string | ||
| is_verified | boolean |
Default: false
|
|
| is_primary | boolean |
Default: false
|
|
| is_validated | boolean |
Default: false
|
|
| created_at | timestamp | ISO-8601 Format | |
| updated_at | timestamp | ISO-8601 Format |
Metadata
| Version | 1.0 |
| Last Updated | July 04, 2016 |
Actions
Add an identity
RESOURCE FIELDS
| Name | Type | Read-only | Description |
|---|---|---|---|
| link | string |
Retrieve link
GET /api/v1/facebook/identity/link.jsonInformation
| Allowed for | Customers, Collaborators, Agents, Admins & Owners |
Arguments
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | string | The callback URL where Facebook will be redirected to. Example: /Helpcenter/home/index |
Response
{
"status": 200,
"data": {
"link": "https://www.facebook.com/v2.2/dialog/oauth?client_id=797588383662629&redirect_uri=https://brewfictus.kayako.com&state=3b6d967fa98ae2290b5e4c4b22a89e10&sdk=php-sdk-4.0.18&scope=read_mailbox"
},
"resource": "oauth_link"
}
Callback handler
GET /api/v1/facebook/identity/callback.jsonInformation
| Allowed for | Customers, Collaborators, Agents, Admins & Owners |
Arguments
| Name | Type | Mandatory | Description |
|---|---|---|---|
| callback | string | callback should be same as used in to retrieve link | |
| code | string | The Facebook code that appears in the querystring | |
| state | string | The Facebook state that appears in the querystring |
Response
{
"status": 201,
"data": {
"identity": {
"id": 1,
"facebook_id": "1407638772888867",
"user_name": null,
"full_name": "Jordan Mitchell",
"email": null,
"bio": null,
"birth_date": null,
"website": null,
"profile_url": null,
"locale": null,
"is_verified": false,
"is_primary": false,
"is_validated": false,
"created_at": "2015-07-25T17:47:14+05:00",
"updated_at": "2015-07-25T17:47:14+05:00",
"resource_type": "identity_facebook"
,"resource_url": "https://brewfictus.kayako.com/api/v1/identities/facebook/1"
}
},
"resource": "facebook_identity_callback"
}