---
title: "fswa_capture_payload — Filter Hook"
description: "Filters the payload stored as the example capture — does not affect what is dispatched."
url: "https://wpwebhooks.org/docs/fswa-capture-payload/"
---

[WP Webhooks](https://wpwebhooks.org/) / [Docs](https://wpwebhooks.org/docs/) / fswa\_capture\_payload

Filter since v1.9.0

# fswa\_capture\_payload

Filters the payload stored as the example capture — does not affect what is dispatched.

/ Signature

```
apply_filters( 'fswa_capture_payload', $payload, $webhook_id, $trigger )
```

/ When it fires

Fires when storing an example payload for use in the field selector and payload mapping UI.

/ Parameters

| Name | In | Type | Req | Description |
| --- | --- | --- | --- | --- |
| $payload | param | array | yes | Payload to be stored as the captured example. |
| $webhook\_id | param | int | yes | Webhook configuration ID. |
| $trigger | param | string | yes | WordPress action name. |

/ Returns

`array` Modified capture payload. Does not affect the dispatched payload.

/ Examples

Strip sensitive data from stored captures

```
add_filter( 'fswa_capture_payload', function ( $payload, $webhook_id, $trigger ) {
    unset( $payload['args'][0]['billing_email'] );
    unset( $payload['args'][0]['billing_phone'] );
    return $payload;
}, 10, 3 );
```

/ Related

[Payload Mapping](https://wpwebhooks.org/docs/payload-mapping/)[fswa\_payload](https://wpwebhooks.org/docs/fswa-payload/)

/Ready

## Your next automation is  
one sentence away.

[Install Plugin→](https://wordpress.org/plugins/flowsystems-webhook-actions/) [See the Plugin →](https://wpwebhooks.org/wordpress-webhook-plugin/)

$ wp plugin install flowsystems-webhook-actions --activate

## Structured data

```json
{"@context":"https://schema.org","@type":"TechArticle","name":"fswa_capture_payload — Filter Hook — Webhook Actions Docs","description":"Filters the payload stored as the example capture — does not affect what is dispatched.","url":"https://wpwebhooks.org/docs/fswa-capture-payload/","isPartOf":{"@type":"WebSite","name":"WP Webhooks","url":"https://wpwebhooks.org"},"about":{"@type":"SoftwareApplication","name":"Webhook Actions","applicationCategory":"WordPress Plugin"}}
```
