Create Webhook

Create a webhook

Options

Body
Values to create a webhook

Request body which must comply to the following JSON Schema:

{
  "required" : [ "events", "url" ],
  "type" : "object",
  "properties" : {
    "url" : {
      "type" : "string",
      "description" : "URL of the webhook",
      "format" : "url",
      "example" : "http://requestb.in/173lyyx1"
    },
    "description" : {
      "type" : "string",
      "description" : "Description of the webhook",
      "example" : "Webhook triggered on unsubscription"
    },
    "events" : {
      "type" : "array",
      "description" : "- Events triggering the webhook. Possible values for **Transactional** type webhook:\n#### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`, `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened` and `unsubscribed`\n- Possible values for **Marketing** type webhook:\n#### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`, `listAddition` & `delivered`\n- Possible values for **Inbound** type webhook:\n#### `inboundEmailProcessed`\n",
      "items" : {
        "type" : "string",
        "example" : "unsubscribed",
        "enum" : [ "sent", "hardBounce", "softBounce", "blocked", "spam", "delivered", "request", "click", "invalid", "deferred", "opened", "uniqueOpened", "unsubscribed", "listAddition", "contactUpdated", "contactDeleted", "inboundEmailProcessed" ]
      }
    },
    "type" : {
      "type" : "string",
      "description" : "Type of the webhook",
      "example" : "marketing",
      "default" : "transactional",
      "enum" : [ "transactional", "marketing", "inbound" ]
    },
    "domain" : {
      "type" : "string",
      "description" : "Inbound domain of webhook, required in case of event type `inbound`",
      "example" : "example.com"
    },
    "batched" : {
      "type" : "boolean",
      "description" : "Batching configuration of the webhook, we send batched webhooks if its true",
      "example" : true
    },
    "auth" : {
      "type" : "object",
      "description" : "Authentication header to be send with the webhook requests",
      "example" : {
        "type" : "bearer",
        "token" : "test-auth-token1234"
      }
    },
    "headers" : {
      "type" : "array",
      "items" : {
        "type" : "object",
        "description" : "Headers send with the requests to the webhook",
        "example" : {
          "key" : "cf-secret",
          "value" : "test-header-value"
        }
      }
    }
  }
}
Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

  • body: Response body
  • status: HTTP status code

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.