younifyd
Menu

Update Page Shield Notification

Update page shield notification webhook.

PATCH/organizations/{organizationId}/page-shield/notifications/{webhookId}

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Update Page Shield Notification action (under Zones (Data API)).
  3. Fill in the fields below, then reference the result from later steps as {{updatePageShieldNotification.response.data}}.

Request

Path parameters

webhookIdstringrequired
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.

webhookIdstring

Webhook ID

enabledboolean

Specifies whether or not the notification is enabled.

zonesarray<string>

Zone names on which to filter notifications alerts. An empty array indicates all storefront zones.

json
{
  "webhookId": "ffffe61cf25e4ec49c34b029ff3060f7",
  "enabled": true,
  "zones": [
    "zone_1234567890abcdef"
  ]
}

Response

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

dataobject

Page shield notification for the webhook response.

idstringrequired

Webhook ID.

namestringrequired

Webhook name.

webhookUrlstringrequired

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.

enabledboolean

Specifies whether or not the notification is enabled.

zonesarray<string>

Zone IDs on which to filter notifications alerts.

json
{
  "data": {
    "id": "webhook_1234567890abcdef",
    "name": "Security Alert Webhook",
    "webhookUrl": "https://example.com/webhook/security",
    "type": "security_alert",
    "createdAt": "2023-01-01T00:00:00Z",
    "lastSuccess": "2023-01-01T12:00:00Z",
    "lastFailure": "2023-01-01T18:00:00Z",
    "enabled": true,
    "zones": [
      "zone_1234567890abcdef"
    ]
  }
}

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