External Services

Return all external services.

Parameters
  • pagequery integer

    Page offset to fetch.

  • per_pagequery integer

    Number of results to return per page.

GET/api/v1/external_services

{
  const res = await fetch(`${BASE_URL}/api/v1/external_services`, {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)});

  const data = await res.json();
}

RESPONSE


External Service

Return an external service.

Parameters
  • idpath integerRequired

    Return a External Service by specific id.

GET/api/v1/external_services/{id}

{
  const res = await fetch(`${BASE_URL}/api/v1/external_services/${id}`, {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)});

  const data = await res.json();
}

RESPONSE


Create Service Click

Registers a click event for external service.

Parameters
  • idpath integerRequired

    Return a External Service by specific id.

  • dataformData, objectRequired

    Form Data needed when registering a click event for external service.

    • typestringRequired

      Provide External Service type. Current selection is only external_service_click_events.

    • relationshipsformData, objectRequired

      Relationships object with external_service object.

      • external_serviceformData, objectRequired

        Add a External Service relationships link.

        • idstringRequired

          Related External Service id.

        • typestringRequired

          External Service type; external_service.

POST/api/v1/external_services/{id}/service_click

{
  const res = await fetch(`${BASE_URL}/api/v1/external_services/${id}/service_click`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(data)});

  const data = await res.json();
}

RESPONSE