Sign in

Welcome.
How can we help?

Webhook app activation

Topic: , Updated:

POST your call data to a webhook endpoint using a simple macro.

Step by step activation

1. Log in to Freespee, open the Apps tab and search for Webhook.

2. Find the Webhook App and click on Activate.

3. Enter your webhook URL endpoint (must be an https endpoint). You can also add an optional webhook url for text messages, an optional macro, an option to send as JSON and optional pre-call webhook. If you leave the macro blank, the default macro will be used. Click Save and Activate to confirm the activation.

4. All set! 

How it works

  • Freespee will POST the data specified by the macro to your webhook endpoint after each call (and optionally before the call)
  • You can choose to send POST data as "application/x-www-form-urlencoded" or JSON.
  • An HTTPS enabled endpoint is mandatory for this App to function
  • Freespee will timeout after 2 seconds
  • Freespee will not retry after a failed request
  • Optionally, you can respond with a JSON containing a value that Freespee will save together will the call. The JSON response must be in the format '{"append":"some_data"}' and the data appended can be maximum 40 characters.

What we send

  • start={start} (start time of call, UTC, format YYYY-MM-DD HH:MM:SS)
  • duration={duration} (duration of call in seconds)
  • from_nr={from_nr} (callers phone number)
  • from_nr_area={from_nr_area} (callers geographical area)
  • to_nr={to_nr} (tracking phone number)
  • end_nr={end_nr} (destination phone number)
  • channel={channel} (channel, ex Google SEM)
  • answered={answered} (answered, 1 or 0)
  • publisher_id={publisher_id} (publisher id, if exists)
  • campaign_id={campaign_id} (campaign id, if exists)
  • referrer={referrer} (visitor referrer url, if exists)
  • url={url} (visitor url, if exists)
  • details={details} (additional details)
  • custnr={custnr} (unique customer ID)
  • event_type={event_type} (type of event 0 = post-call, 1 = textMessage/SMS, 2 = pre-call)
  • id={id} (Unique callid)

Getting Started

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments


Not the answer to your question?

Powered by Zendesk