Handling Events and Payloads

You can set up webhooks in Transposit to enable data to be received from external services.

Webhooks help you quickly identify and respond to incidents, requests, or any other operational event.

Connect to services like Datadog, Pagerduty, BigPanda, CircleCI, and any other service that provides support for webhooks.

Setting Up the Webhook#

  1. Display the Webhooks. In your project, select Webhooks to display all your webhooks.

    By default, you will have no webhooks registered, as shown above. When you have one or more webhooks registered, the Webhooks page will look as follows.

  2. Create a Webhook. Click Add webhook to begin defining a webhook.

    Click Submit.

  3. In the Payload Editor, choose the payload of your choice.

    Several payload samples are provided, with the editor filled with the payload of your choice.

    Click Extract Fields.

  4. Save Fields for Mapping. Click on the plus icon in the left margin of a payload line to save that field for mapping in the next step.

    Click Template to go to the next step.

You can always come back to this screen from the Webhooks page to edit or optimize further.

  1. Define an Alert Template. In the Template page, define the type of activity you want the webhook to create.

    Click Map saved fields.

  2. Assign Fields to Activities. In the Map saved fields page use drag and drop to assign a saved field from the pane on the left to the relevant activity field on the right. Alternatively, instead of using drag and drop, click Data, to select the extracted field you need.

The activity fields on the right are those marked as Required in the template assigned to the Webhook.

  1. Save the Webhook. Click Save Webhook when you're happy with how you've set up your webhook.

Using the Webhook#

  1. Finetune the Webhook. In the Webhooks page, click Debug Webhook to work with the payload and click Edit Webhook to finetune the webhook as needed.

  2. Use the Sample cUrl. In the Webhooks page, click Debug Webhook or Edit Webhook and notice the link in the bottom left to the sample cURL.

  3. Register the Webhook in the External Service. Copy the webhook URL and register it as part of the webhook definition in the applicable external service.

  4. Observe the Newly Created Activities. When a webhook is triggered by the external service, notice that a new activity is automatically created in Transposit.

  5. Observe the Newly Created Events in the Timeline. Within the activity's timeline, the incoming webhook event is automatically shown.

  6. Observe the Mapped Data Value in the Details Tab. The Details tab automatically shows the data that you mapped while setting up the webhook in Transposit.