Get Webhook

Get webhook by ID.

GET/organizations/{organizationId}/webhook/{webhookId}

Use it in a workflow

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

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

webhookIdstringrequired

Response

Returns 200 with an object. Read it in later steps with {{getWebhook.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?