The Affiliate Profile Change Webhook plugin allows you to automatically notify external systems whenever selected fields in an affiliate's profile are changed. When triggered, it sends a JSON webhook containing the previous and new values of the changed fields, the timestamp of the change, and any additional affiliate data you choose to include. This plugin is ideal for keeping your CRM, compliance, or notification systems in sync with affiliate profile updates in Post Affiliate Pro.
How the Affiliate Profile Change Webhook Works
Whenever an affiliate’s profile is updated and any of the watched fields are changed, the plugin sends an HTTP POST request with a JSON payload to your configured endpoint. The payload includes:
- The date and time of the change
- The old and new values of all watched fields that were changed
- Any additional affiliate or parent affiliate fields you selected for inclusion
This mechanism enables real-time integration between your affiliate system and external platforms such as databases, notification systems, or KYC/compliance solutions.
Plugin Setup
- Activate the Affiliate Profile Change Webhook plugin in your Post Affiliate Pro merchant panel (Configuration > Plugins).
- Configure the plugin settings (see below).
- Provide your webhook endpoint—this is the URL where profile change notifications will be sent.
- Select the affiliate profile fields you wish to watch for changes.
- Optionally select extra fields you want included in the webhook payload for richer context.
Configuration Options
The plugin offers the following configuration fields:
| Field | Description |
|---|---|
| Watched fields | Select which affiliate profile fields should be monitored for changes. When any of these fields are changed, a webhook will be triggered. |
| Webhook endpoint | The URL (including protocol, e.g. https://...) to which the webhook notification will be POSTed. |
| Webhook data | Select any additional affiliate or parent affiliate fields to include in the webhook payload. These are sent in addition to the changed fields. For example, you may want to always include the affiliate’s email or refID. |
Insert a screenshot of the plugin configuration form here.
Webhook Payload Details
When a watched field is changed, the plugin sends a JSON-encoded POST request to your configured endpoint. The payload contains:
changes: An object containing the datetime of the change, and for each watched field that was changed, its old and new value (e.g.nameold,namenew,usernameold,usernamenew, etc.)- Additional data fields you selected in the configuration
Example Webhook Payload
{
"changes": {
"datetime_changed": "2019-09-12T06:42:44-07:00",
"nameold": "Johann Schmied",
"namenew": "John Smith",
"usernameold": "johann@company.com",
"usernamenew": "john@company.com",
"rstatusold": "P",
"rstatusnew": "A" },
"firstname": "John",
"ip": "123.100.20.0",
"lastname": "Smith",
"name": "John Smith",
"notificationemail": "",
"parentuserid": "13671b44",
"photo": "https://url.to/image.jpg",
"refid": "5d25b8f38d829",
"username": "john@company.com" }
Fields Available for the Webhook
You can include any of the following fields in the webhook (as watched fields or additional data):
- userid
- rstatus
- name
- firstname
- lastname
- username
- ip
- photo
- parentuserid
- refid
- notificationemail
- data1 ... data25
- parent_name
- parent_firstname
- parent_lastname
- parent_username
- parent_ip
- parent_photo
- parent_parentuserid
- parent_refid
- parent_notificationemail
- parent_data1 ... parent_data25
Security
- Only POST requests are sent.
- The webhook endpoint should be secured on your side (e.g. by validating the source IP, authenticating requests, or using HTTPS).
- The plugin validates the webhook endpoint during configuration to ensure it is a valid URL.
Troubleshooting & Tips
- If your external system does not receive webhook notifications, verify that the endpoint URL is correct and accessible from the internet.
- Make sure the watched fields and additional data fields are selected correctly in the plugin configuration.
- Use your server’s HTTP logs or webhook debugging services (such as PostBin or RequestBin) to view incoming requests and debug payloads.
- The plugin will only send the old/new values for fields that were actually changed, but you can always include other static fields for context via the “Webhook data” setting.
Summary
The Affiliate Profile Change Webhook plugin is a powerful tool for real-time synchronization of affiliate data with external systems. By sending detailed JSON notifications whenever an affiliate profile is changed, it enables seamless integrations for compliance, notifications, and business intelligence.
If you need further assistance, please contact our support team.