Webhooks

Prerequisites

• WooCommerce API Keys: You need Consumer Key and Consumer Secret.
• Base URL: Replace https://yourstore.com with your actual WooCommerce store URL.
• Authorization: Basic Auth with your Consumer Key and Consumer Secret.

Authorization Setup in Postman

1. Go to the Authorization tab.
2. Select Type: Basic Auth.
3. Username: Enter your Consumer Key.
4. Password: Enter your Consumer Secret.

1. List Webhooks

• URL: https://yourstore.com/wp-json/wc/v3/webhooks
• Method: GET
• Headers:
  • Authorization: Basic Auth

Example in Postman:

1. Set method to GET.
2. Enter URL: https://yourstore.com/wp-json/wc/v3/webhooks
3. Go to the Authorization tab and set Type to Basic Auth.
4. Enter Consumer Key and Consumer Secret.
5. Send the request.

2. Retrieve a Webhook

• URL: https://yourstore.com/wp-json/wc/v3/webhooks/{id}
• Method: GET
• Headers:
  • Authorization: Basic Auth
• Replace {id} with the actual webhook ID.

Example in Postman:

1. Set method to GET.
2. Enter URL: https://yourstore.com/wp-json/wc/v3/webhooks/{id}
3. Go to the Authorization tab and set Type to Basic Auth.
4. Enter Consumer Key and Consumer Secret.
5. Send the request.

3. Create a Webhook

• URL: https://yourstore.com/wp-json/wc/v3/webhooks
• Method: POST
• Headers:
  • Authorization: Basic Auth
• Body: JSON with webhook data.

Example JSON Body:

{
  "name": "Order Created Webhook",
  "status": "active",
  "topic": "order.created",
  "delivery_url": "https://yourwebhookurl.com",
  "secret": "your_webhook_secret"
}

Example in Postman:

1. Set method to POST.
2. Enter URL: https://yourstore.com/wp-json/wc/v3/webhooks
3. Go to the Authorization tab and set Type to Basic Auth.
4. Enter Consumer Key and Consumer Secret.
5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
6. Send the request.

4. Update a Webhook

• URL: https://yourstore.com/wp-json/wc/v3/webhooks/{id}
• Method: PUT
• Headers:
  • Authorization: Basic Auth
• Body: JSON with updated webhook data.
• Replace {id} with the actual webhook ID.

Example JSON Body:

{
  "status": "paused"
}

Example in Postman:

1. Set method to PUT.
2. Enter URL: https://yourstore.com/wp-json/wc/v3/webhooks/{id}
3. Go to the Authorization tab and set Type to Basic Auth.
4. Enter Consumer Key and Consumer Secret.
5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
6. Send the request.

5. Delete a Webhook

• URL: https://yourstore.com/wp-json/wc/v3/webhooks/{id}
• Method: DELETE
• Headers:
  • Authorization: Basic Auth
• Replace {id} with the actual webhook ID.

Example in Postman:

1. Set method to DELETE.
2. Enter URL: https://yourstore.com/wp-json/wc/v3/webhooks/{id}
3. Go to the Authorization tab and set Type to Basic Auth.
4. Enter Consumer Key and Consumer Secret.
5. Send the request.

6. Batch Update Webhooks

• URL: https://yourstore.com/wp-json/wc/v3/webhooks/batch
• Method: POST
• Headers:
  • Authorization: Basic Auth
• Body: JSON with batch operations.

Example JSON Body:

{
  "update": [
    {
      "id": 1,
      "status": "paused"
    },
    {
      "id": 2,
      "status": "active"
    }
  ]
}

Example in Postman:

1. Set method to POST.
2. Enter URL: https://yourstore.com/wp-json/wc/v3/webhooks/batch
3. Go to the Authorization tab and set Type to Basic Auth.
4. Enter Consumer Key and Consumer Secret.
5. Go to the Body tab, select raw, choose JSON from the dropdown, and paste the example JSON body.
6. Send the request.

By following these instructions, you can test each WooCommerce webhooks endpoint in Postman. Each request should include the necessary Authorization header configured through Basic Auth with your Consumer Key and Consumer Secret. Adjust the {id} parameter with the actual webhook ID you intend to work with for retrieving, updating, or deleting operations. Adjust the base URL and endpoint as needed based on your WooCommerce store setup and the specific webhooks you want to manage.