Hosting An API Tipline

An API tipline receives tip sent via HTTP request to the tipline's API endpoint. Use the following instructions to complete the process of Configuring Tipline Properties.

If modifying an existing tipline, click the edit link associated with the desired tipline as shown on the "Manage Tiplines" Page. It will bring up an "Edit Tipline" form similar to the one shown below. If you are in the process of creating a new tipline, you may already see a form called "New Tipline" which is similar and will serve the same purpose.

Choose A Name

The name you provide will distinguish this tipline from others listed on the "Manage Tiplines" page for your organization.

Identifier

Choose an alphanumeric name to represent your tipline which you will then use with the POST /submissions/{tiplineIdentifier} endpoint.

Heading

Leave this field blank for this type of tipline.

Custom Response

Leave this field blank for this type of tipline.

Custom Merged Response

Leave this field blank for this type of tipline.

Redirect URL

Leave this field blank for this type of tipline.

Tipline Type

Use the pulldown menu to select "API".

Include this tipline in your Address Card and QR code?

Leave this box unchecked for this type of tipline.

Enabled

Check this box to enable the tipline or uncheck to temporarily deactivate it.

Anonymous submissions require approval

Check this box to hold tips for approval when the source of the tip is not identified as a member of your organization.

Real submissions require approval

Check this box to hold all tips for approval.

Multi-part merge submissions

Leave this box unchecked for this type of tipline.