Webhook

Call a webhook This page documents the Webhook module, including its variants, capabilities, and the result values it returns.

Webhook: Webhook

Capabilities

The module returns the following capabilities.

Status

Status of the webhook call

Code	Label	Description
`sent`	Sent	Webhook called successfully
`error`	error	Webhook call failed

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Sent`	Status is `sent`	[Describe.]
`Error`	default, when no conditions matched	[Describe.]

Input payload

The following is a sample payload used to submit data to the Webhook module for processing.

JSON

{
  "context": {
    "config": {
      "previewUrl": "https://example.com/webhook",
      "productionUrl": "https://example.com/webhook",
      "message": "foo",
      "iSO8602TimeoutDuration": "PT2M",
      "includeMessage": true
    },
    "subject": {
      "identity": {
        "firstName": "John"
      }
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "status": "error"
    },
    "outcome": "Error"
  }
}

Webhook: Webhook Notification

Journey-completion notification webhook (trigger-only, signed). Platform-invoked via the module executor; not customer-selectable.

Capabilities

The module returns the following capabilities.

Status

Status of the notification webhook call

Code	Label	Description
`sent`	Sent	Notification webhook called successfully
`error`	error	Notification webhook call failed

Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

Outcome	Condition	Description
`Sent`	Status is `sent`	[Describe.]
`Error`	default, when no conditions matched	[Describe.]

Input payload

The following is a sample payload used to submit data to the Webhook Notification module for processing.

JSON

{
  "context": {
    "config": {
      "url": "http://mockfailure.internal",
      "authType": "none",
      "iSO8602TimeoutDuration": "PT2M"
    },
    "subject": {
      "identity": {}
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "status": "error"
    },
    "outcome": "Error"
  }
}

Capabilities

Status

Status of the webhook call

Value	Description
`sent`	Webhook called successfully
`error`	Webhook call failed

Input payload

The following is a sample payload used to submit data to the Webhook module for processing.

JSON

{
  "context": {
    "config": {
      "iSO8602TimeoutDuration": "PT2M",
      "includeMessage": true,
      "message": "foo",
      "previewUrl": "https://example.com/webhook",
      "productionUrl": "https://example.com/webhook"
    },
    "subject": {
      "identity": {
        "firstName": "John"
      }
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "status": "error"
    },
    "outcome": "Error"
  }
}

Webhook Notification

Capabilities

Status

Status of the notification webhook call

Value	Description
`sent`	Notification webhook called successfully
`error`	Notification webhook call failed

Input payload

The following is a sample payload used to submit data to the Webhook Notification module for processing.

JSON

{
  "context": {
    "config": {
      "authType": "none",
      "iSO8602TimeoutDuration": "PT2M",
      "url": "http://mockfailure.internal"
    },
    "subject": {
      "identity": {}
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "status": "error"
    },
    "outcome": "Error"
  }
}

Get Started

Platform

API-first integration

Hosted journey

Digital IDs

Resources

Webhook

Webhook: Webhook

Capabilities

Status

Default outcomes

Input payload

Sample response

Webhook: Webhook Notification

Capabilities

Status

Default outcomes

Input payload

Sample response

Webhook

Capabilities

Status

Input payload

Sample response

Webhook Notification

Capabilities

Status

Input payload

Sample response

​Webhook: Webhook

​Capabilities

​Status

​Default outcomes

​Input payload

​Sample response

​Webhook: Webhook Notification

​Capabilities

​Status

​Default outcomes

​Input payload

​Sample response

​Webhook

​Capabilities

​Status

​Input payload

​Sample response

​Webhook Notification

​Capabilities

​Status

​Input payload

​Sample response

Webhook: Webhook

Capabilities

Status

Default outcomes

Input payload

Sample response

Webhook: Webhook Notification

Capabilities

Status

Default outcomes

Input payload

Sample response

Webhook

Capabilities

Status

Input payload

Sample response

Webhook Notification

Capabilities

Status

Input payload

Sample response