Create Webhook

Create webhook.

POST/organizations/{organizationId}/webhook

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Create Webhook action (under Zones (Data API)).
Fill in the fields below, then reference the result from later steps as {{createWebhook.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

Request body

Enter the body as JSON in the step's Body field.

namestringrequired

Webhook name

urlstringrequired

Webhook URL

secretstring

Webhook optional secret

json

{
  "name": "My Webhook",
  "url": "https://example.com/webhook",
  "secret": "webhook_secret_123"
}

Response

Returns 201 with an object. Read it in later steps with {{createWebhook.response.data.<field>}}.

dataobject

Webhook response

idstringrequired

Webhook ID

namestringrequired

Webhook name

urlstringrequired

Webhook URL

typestringrequired

Webhook type

createdAtstring (date-time)required

Timestamp of webhook creation

lastSuccessstring (date-time)

Timestamp of the last successful notification

lastFailurestring (date-time)

Timestamp of the last failed notification

json

{
  "data": {
    "id": "ffffe61cf25e4ec49c34b029ff3060f7",
    "name": "My Webhook",
    "url": "https://example.com/webhook",
    "type": "webhook",
    "createdAt": "2023-01-01T00:00:00Z",
    "lastSuccess": "2023-01-01T12:00:00Z",
    "lastFailure": "2023-01-01T18:00:00Z"
  }
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?