Docs

Changelog

Changes to the Tepez API that affect existing integrations, newest first, with what to change in your code.

This page lists the changes to the Tepez API that can affect an existing integration, newest first. Each change says what changed and what you need to do. If your integration was built from older documentation, check it against every change below.

March 2025: no filters on entry data in GET /entry

What changed: the query parameter of GET /entry no longer accepts filters on the entry's data, such as {"_data.formStage": "approved"}. It accepts only the keys listed in Filter with query: form, _id, status, changedAt, modifyTime and deleted. Any other key fails:

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"query._data.formStage\" is not allowed",
  "validation": { "source": "query", "keys": ["query._data.formStage"] }
}

What you need to do: filter by form, status and a date, ask only for the fields you need with fields, and filter the results by their data in your system. See No filters on the entry's data.

June 2022: no sort in GET /entry

What changed: GET /entry no longer sorts. Since June 2022 entries come back oldest first; since July 2022 a sort parameter, such as sort={"_id":-1}, is ignored rather than rejected.

What you need to do: sort the entries in your system. To fetch only recent entries, filter by changedAt rather than sorting newest first and stopping early. See Filter with query.

What changed: the links to the forms app lost their #. A form's fill link moved from https://app.tepez.co.il/#/f/<formId>/ to https://app.tepez.co.il/f/<formId>/, and a draft's link from https://app.tepez.co.il/#/e/<entryId>/?b=<bewit> to https://app.tepez.co.il/e/<entryId>/?b=<bewit>. The app still redirects the old links.

What you need to do: build new links in the new form, and move ?data= prefill parameters to the new form too (see Prefill a form). Better still, don't build draft links yourself: use the resumeUrlBewit the API returns on the entry.

July 2017: new response of POST /entry/save

What changed: POST /entry/save no longer returns a message. It returns the saved entry under entry, with uiActions and userCanResume. The formId, entryId and bewit properties are still there:

{
  "entry": { "id": "<entryId>", "status": "saved", "resumeUrlBewit": "https://app.tepez.co.il/e/<entryId>/?b=<bewit>" },
  "uiActions": [{ "type": "continueLater" }],
  "userCanResume": true,
  "formId": "<formId>",
  "entryId": "<entryId>",
  "bewit": "<bewit>"
}

What you need to do: stop reading message, and check the HTTP status for success. Read the new entry from entry, for example its id from entry.id and the person's link from entry.resumeUrlBewit. See Save a draft.

Question about this page? Email support@tepez.co.il

On this page