tiempoAPI reference
API reference

Webhook endpoints

Where Tiempo sends events. One endpoint hears from every business on your platform. Each endpoint reports its health: when it last worked, and since when it has been failing. One that fails every delivery for 3 days is turned off (disabled_reason "failing") until you turn it back on; then resend what it missed. Platform-level: no Tiempo-Account header.

Create a webhook endpoint

POST/v1/webhook_endpoints

Live endpoints need https and a public host. The response includes the endpoint’s signing secret, once.

Body parameters

  • urlstringrequired

    Where to POST events. https in live mode; a public host.

  • enabled_eventsarray of stringsrequired

    Event types to send, or ["*"] for all.

  • api_versionstring

    The API version events are rendered in for this endpoint. Defaults to your platform’s.

  • descriptionstring

    Your note.

  • metadatamap

    Up to 50 keys of your own (strings, keys up to 40 characters, values up to 500). Returned on every read and webhook. On update, an empty string removes a key.

List webhook endpoints

GET/v1/webhook_endpoints

Query parameters

  • limitinteger

    1 to 100. Defaults to 20.

  • starting_afterstring

    An object id from the previous page; returns the page after it.

  • ending_beforestring

    An object id; returns the page before it.

  • metadata[key]string

    Only objects whose metadata has this key and value. Repeat for several.

Retrieve a webhook endpoint

GET/v1/webhook_endpoints/{id}

Path parameters

  • idstringrequired

    The object’s id.

Update a webhook endpoint

POST/v1/webhook_endpoints/{id}

Path parameters

  • idstringrequired

    The object’s id.

Body parameters

  • urlstring

    Where to POST events. https in live mode; a public host.

  • enabled_eventsarray of strings

    Event types to send, or ["*"] for all.

  • api_versionstring

    The API version events are rendered in for this endpoint. Defaults to your platform’s.

  • disabledboolean

    true pauses deliveries; false turns the endpoint back on, including after Tiempo turned it off for failing.

  • descriptionstring

    Your note.

  • metadatamap

    Up to 50 keys of your own (strings, keys up to 40 characters, values up to 500). Returned on every read and webhook. On update, an empty string removes a key.

Resend to an endpoint

POST/v1/webhook_endpoints/{id}/resend

Queues again every delivery to this endpoint that gave up, and every event it never got (while it was off, or before it listened for that type), for events created between since and until. Without since: from when it started failing, else the last 3 days. Up to 1,000 per call; has_more means call again. Safe to repeat. If the endpoint is off, the deliveries wait until you turn it on.

Path parameters

  • idstringrequired

    The object’s id.

Body parameters

  • sincetimestamp

    Events created from this instant.

  • untiltimestamp

    Events created before this instant. Defaults to now.

Delete a webhook endpoint

DELETE/v1/webhook_endpoints/{id}

Stops deliveries, including retries already queued.

Path parameters

  • idstringrequired

    The object’s id.