Batch Webhooks

Batch create, update, and delete webhooks

POST/webhooks/batch

Use it in a workflow

Add a step and choose the WooCommerce connector.
Pick the Batch Webhooks action (under Webhooks).
Fill in the fields below, then reference the result from later steps as {{batchWebhooks.response.data}}.

Request

Request body

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

createarray<object>

idinteger

Unique identifier for the resource. read-only

namestring

A friendly name for the webhook. mandatory

statusstring

Webhook status.

One ofactivepauseddisabledDefault "active"

topicstring

Webhook topic. mandatory

resourcestring

Webhook resource. read-only

eventstring

Webhook event. read-only

hooksarray<string>

WooCommerce action names associated with the webhook. read-only

delivery_urlstring (uri)

The URL where the webhook payload is delivered. mandatory

secretstring

Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided.

date_createdstring (date-time)

The date the webhook was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the webhook was created, as GMT. read-only

date_modifiedstring (date-time)

The date the webhook was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the webhook was last modified, as GMT. read-only

updatearray<object>

idinteger

Unique identifier for the resource. read-only

namestring

A friendly name for the webhook. mandatory

statusstring

Webhook status.

One ofactivepauseddisabledDefault "active"

topicstring

Webhook topic. mandatory

resourcestring

Webhook resource. read-only

eventstring

Webhook event. read-only

hooksarray<string>

WooCommerce action names associated with the webhook. read-only

delivery_urlstring (uri)

The URL where the webhook payload is delivered. mandatory

secretstring

Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided.

date_createdstring (date-time)

The date the webhook was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the webhook was created, as GMT. read-only

date_modifiedstring (date-time)

The date the webhook was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the webhook was last modified, as GMT. read-only

deletearray<integer>

json

{
  "create": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "topic": "string",
      "resource": "string",
      "event": "string",
      "hooks": [
        "string"
      ],
      "delivery_url": "string",
      "secret": "string",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z"
    }
  ],
  "update": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "topic": "string",
      "resource": "string",
      "event": "string",
      "hooks": [
        "string"
      ],
      "delivery_url": "string",
      "secret": "string",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z"
    }
  ],
  "delete": [
    0
  ]
}

Response

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

createarray<object>

idinteger

Unique identifier for the resource. read-only

namestring

A friendly name for the webhook. mandatory

statusstring

Webhook status.

One ofactivepauseddisabledDefault "active"

topicstring

Webhook topic. mandatory

resourcestring

Webhook resource. read-only

eventstring

Webhook event. read-only

hooksarray<string>

WooCommerce action names associated with the webhook. read-only

delivery_urlstring (uri)

The URL where the webhook payload is delivered. mandatory

secretstring

Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided.

date_createdstring (date-time)

The date the webhook was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the webhook was created, as GMT. read-only

date_modifiedstring (date-time)

The date the webhook was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the webhook was last modified, as GMT. read-only

updatearray<object>

idinteger

Unique identifier for the resource. read-only

namestring

A friendly name for the webhook. mandatory

statusstring

Webhook status.

One ofactivepauseddisabledDefault "active"

topicstring

Webhook topic. mandatory

resourcestring

Webhook resource. read-only

eventstring

Webhook event. read-only

hooksarray<string>

WooCommerce action names associated with the webhook. read-only

delivery_urlstring (uri)

The URL where the webhook payload is delivered. mandatory

secretstring

Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided.

date_createdstring (date-time)

The date the webhook was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the webhook was created, as GMT. read-only

date_modifiedstring (date-time)

The date the webhook was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the webhook was last modified, as GMT. read-only

deletearray<object>

idinteger

Unique identifier for the resource. read-only

namestring

A friendly name for the webhook. mandatory

statusstring

Webhook status.

One ofactivepauseddisabledDefault "active"

topicstring

Webhook topic. mandatory

resourcestring

Webhook resource. read-only

eventstring

Webhook event. read-only

hooksarray<string>

WooCommerce action names associated with the webhook. read-only

delivery_urlstring (uri)

The URL where the webhook payload is delivered. mandatory

secretstring

Secret key used to generate a hash of the delivered webhook and provided in the request headers. This will default is a MD5 hash from the current user's ID|username if not provided.

date_createdstring (date-time)

The date the webhook was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the webhook was created, as GMT. read-only

date_modifiedstring (date-time)

The date the webhook was last modified, in the site's timezone. read-only

date_modified_gmtstring (date-time)

The date the webhook was last modified, as GMT. read-only

json

{
  "create": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "topic": "string",
      "resource": "string",
      "event": "string",
      "hooks": [
        "string"
      ],
      "delivery_url": "string",
      "secret": "string",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z"
    }
  ],
  "update": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "topic": "string",
      "resource": "string",
      "event": "string",
      "hooks": [
        "string"
      ],
      "delivery_url": "string",
      "secret": "string",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z"
    }
  ],
  "delete": [
    {
      "id": 0,
      "name": "string",
      "status": "active",
      "topic": "string",
      "resource": "string",
      "event": "string",
      "hooks": [
        "string"
      ],
      "delivery_url": "string",
      "secret": "string",
      "date_created": "2025-01-01T00:00:00Z",
      "date_created_gmt": "2025-01-01T00:00:00Z",
      "date_modified": "2025-01-01T00:00:00Z"
    }
  ]
}

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

Was this page helpful?