Survey data - Rest Services

Retrieve an external service

get/api/v2/assets/{uid_asset}/hooks/{uid_hook}/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

uid_assetstring required

UID of the parent assets

uid_hookstring required

UID of the hook

Response

activeboolean
assetinteger required
auth_level'no_auth' | 'basic_auth'
  • no_auth - no_auth
  • basic_auth - basic_auth
date_modifiedstring date-time required
email_notificationboolean
endpointstring required
export_type'xml' | 'json'
  • xml - xml
  • json - json
failed_countinteger required
logs_urlstring uri required
namestring required
payload_templatestring nullable
pending_countinteger required
subset_fieldsstring[]
success_countinteger required
uidstring required
urlstring uri required

Example response

{
  "logs_url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/hooks/hZzzeedWxQoFHgibsTCysv/logs/",
  "url": "https://kf.kobotoolbox.org/api/v2/assets/a3C9wWefqZVkChNLKqqXVZ/"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.