POST /api/v1/webhooks

This endpoint allows you to create a new webhook by providing the event type and the URL.

Example Request Body

The request body should be in raw format and should contain below fields:

eventType (string, required): The type of event for the webhook.
url (string, required): The URL where the webhook payload will be sent.

Below example shows how to subscribe to Stop assignment event.

{
  "eventType": "stop.assigned",
  "url": "https://hookb.in/"
}

Sample code

Java

NodeJS

PHP

Python

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://api.locate2u.com/api/v1/webhooks");
request.Headers.Add("Authorization", "Bearer yourBearerTokenHere");
var content = new StringContent("{\"eventType\": \"my.event\", \"url\" : \"https://my/ac3534dc-ddf4-47ad-b617-8fb984434bcd\"}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"eventType\": \"stop.assigned\", \"url\" : \"https://webhook.site/ac3534dc-ddf4-47ad-b617-8fb984434bcd\"}");
Request request = new Request.Builder()
  .url("http://api.locate2u.com/api/v1/webhooks")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer yourBearerTokenHere")
  .build();
Response response = client.newCall(request).execute();

var http = require('follow-redirects').http;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': 'api.locate2u.com',
  'path': '/api/v1/webhooks',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer Bearer yourBearerTokenHere'
  },
  'maxRedirects': 20
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "eventType": "stop.assigned",
  "url": "https://webhook.site/ac3534dc-ddf4-47ad-b617-8fb984434bcd"
});

req.write(postData);

req.end();

 'http://api.locate2u.com/api/v1/webhooks',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{"eventType": "stop.assigned", "url" : "https://webhook.site/ac3534dc-ddf4-47ad-b617-8fb984434bcd"}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer yourBearerTokenHere'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests
import json

url = "http://api.locate2u.com/api/v1/webhooks"

payload = json.dumps({
  "eventType": "stop.assigned",
  "url": "https://webhook.site/ac3534dc-ddf4-47ad-b617-8fb984434bcd"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer yourBearerTokenHere'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Response

Example response code for a success:

201 

{
  "id": "stop.assigned"
}

API

Sample code

Response