Webhook

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

Webhook: Webhook

Call a 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`	The webhook call succeeded.
`Error`	default, when no conditions matched	An unexpected error occurred.

Input payload

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

JSON

{
  "context": {
    "config": {
      "includeMessage": true,
      "message": "foo",
      "previewUrl": "http://mocksuccess.internal",
      "productionUrl": "http://mocksuccess.internal"
    },
    "subject": {
      "identity": {}
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "status": "sent"
    },
    "outcome": "Sent"
  }
}

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`	The webhook call succeeded.
`Error`	default, when no conditions matched	An unexpected error occurred.

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://mocksuccess.internal"
    },
    "subject": {
      "identity": {}
    }
  }
}

Sample response

The following is a sample response returned by the module.

JSON

{
  "response": {
    "advice": {
      "status": "sent"
    },
    "outcome": "Sent"
  }
}

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"
  }
}

The following guides and tutorials use this module or explain how to configure it.

How to use and configure a Webhook module in Go

Configure webhooks in GBG Go.

Troubleshooting

Diagnose and resolve common issues.

How to use the Manual Review module in Go

Use manual review steps in GBG Go.

Configure journey completion notifications

Get notified in real time when a journey completes.

Get Started

Platform

Developer Integration

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

How to use and configure a Webhook module in Go

Troubleshooting

How to use the Manual Review module in Go

Configure journey completion notifications

​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

​Related guides and tutorials

How to use and configure a Webhook module in Go

Troubleshooting

How to use the Manual Review module in Go

Configure journey completion notifications

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

Related guides and tutorials