Endlinks Introduction

Endlinks are a powerful feature of the TARTLE marketplace that enable a simple integration between TARTLE and external systems. They provide a mechanism to direct sellers from TARTLE to your website or application while maintaining contextual information about the interaction.

An Endlink is a special type of question within a TARTLE data packet that contains a URL specified by the buyer. When a seller views the packet, this URL is presented as a clickable link. The system adds specific parameters to the URL, primarily the tartle_endlink_token, which is a secure token which will allow TARTLE to identifiy both the seller and the specific packet question later when the buyer calls the Endlink endpoints.

Key Characteristics

  • Endlinks are typically designed to be the only question in a packet
  • They serve as a bridge between TARTLE and external systems
  • They enable verification and feedback for user actions on external systems
  • They support various integration patterns (api calls, redirects, or with a widget)
1

A user clicks an Endlink in their TARTLE packet

2

They're redirected to your site with the `tartle_endlink_token` in the URL parameters

3

Your application captures this token from the URL

4

After user completes your flow, your code reports the outcome to TARTLE

There are a number of ways to capture and save the token, as well as how to report it back to TARTLE. Later in this guide we will show you those options alongside our recommendations.

TARTLE provides four endpoints to report the status of an Endlink interaction

https://source.tartle.co/api/v3/endlinks/complete?tartle_endlink_token=<token>
https://source.tartle.co/api/v3/endlinks/fail?tartle_endlink_token=<token>
https://source.tartle.co/api/v3/endlinks/quota_full?tartle_endlink_token=<token>
https://source.tartle.co/api/v3/endlinks/screenout?tartle_endlink_token=<token>
  • Name
    tartle_endlink_token
    Type
    string
    Description

    The token that was present as a parameter to the endlink URL when the user landed on your site from TARTLE.

  • Complete: Marks the packet as successfully completed and publishes it.
  • Fail: Marks the interaction as failed and filters the packet from the seller's list
  • Quota Full: Indicates your quota is full and filters the packet from the seller's list
  • Screen Out: Indicates the seller did not qualify and filters the packet from the seller's list

The following pages will guide you through the steps for creating a packet with an endlink, extracting and storing the token on your site and using it to report the results of the user's actions.

Continue to the Creating endlinks page to get started.

Was this page helpful?