Webhook

Setting up the Integration

1

Add your Webhook URL

To set up your Webhook integration, add the link to which Luciq should forward your reports. You can also choose which details get forwarded.

2

Select products and test

Select the products that you would like to integrate with, whether Bugs & Crashes or APM, and test your integration so that everything is working smoothly.

3

Finish and enable forwarding

All done! Your integration is now set up and ready. From this final page, you can allow automatic forwarding (this can be reconfigured at any time).

Below, you can find more details about the JSON payloads that you will receive.

Crashes' JSON model:

JSON

{
    "Exception": "String",
    "Number": "Number",
    "URL": "String",
    "Status": "String",
    "Email": "",
    "Reported At": "String",
    "Location": "String",
    "Device": "String",
    "Memory": "String",
    "Storage": "String",
    "Connectivity": "string",
    "Battery": "string",
    "App Version": "string",
    "Duration": "number",
    "User Data": "String",
    "Console Log": "Text",
    "Luciq Log": "Text",
    "User Steps": "Text",
    "User Attributes": {},
    "Current View": "String",
    "Locale": "en_US",
    "Orientation": "landscape",
    "Screen Size": "String",
    "Density": "string",
    "Image Attachments": []
}

Bugs' JSON model:

JSON

{
  "Title": "String",
  "Reported At": "String",
  "Email": "String",
  "Private URL": "String",
  "Categories": "String",
  "Tags": "String",
  "App Version": "String",
  "Device": "String",
  "Location": "String",
  "Duration": Integer,
  "Screen Size": "String",
  "Density": "String",
  "User Attributes": {

  },
  "User Data": "String",
  "User Steps": "String",
  "Luciq Log": "String",
  "Console Log": "String",
  "Locale": "String",
  "Image Attachments": [

  ],
  "Non Image Attachments": [

  ],
  "Type": "bug",
  "URL": "String"
}

APMs' JSON model:

JSON

{
  "title": "String",
  "trace": "String",
  "trigger": "String",
  "trigger_operator": "String",
  "test_value": "Number",
  "duration": "String",
  "conditions": [
    {
      "key": "String",
      "operator": "String",
      "value": "String"
    }
  ],
  "current_value": "String",
  "metric": "String",
  "application": "String",
  "platform": "String",
  "url": "String"
}

Using Secret Tokens

Ensure your server is only receiving the expected Luciq requests for security reasons.

1

Creating a secret

Create a random alphanumeric secret that’s at least 16 characters and has a maximum of 64 characters.

Here’s a sample secret: d8yyxj7srjqf5xyih8ay

Note: please make sure to save this secret.

2

Bind the secret with Webhooks

Create a Webhook integration on Luciq then enter the secret you created in the “Secret token” field.

3

Save the integration

After saving the integration, each request that is sent from this integration will have an extra field in the header called x-lcq-signature-256.

4

Authenticate incoming requests

Once your server receives the response from Luciq, do the following:

• Hash the response body using the Secret token you created.

• Use the sha256 algorithm for hashing.

• Compare the result of the hash with the header x-lcq-signature-256.

5

Verify the signature

• If the results are equal, then it means it’s sent from Luciq.

• If they are not equal, then it’s not sent from Luciq.