Create a webhook | Redpin

Subscribe to real-time status updates for customers, virtual accounts, and payments. When you create a webhook, you’ll receive JSON notifications at your specified endpoint whenever status changes occur.

Webhook Payload Mapping:

If you subscribe to CUSTOMER STATUS, your webhook will receive the payload described in the customer_status_updated event.
If you subscribe to VBAN STATUS, your webhook will receive the payload described in the virtual_account_status_updated event.
If you subscribe to PAYMENT STATUS, your webhook will receive the payload described in the payment_status_updated event.
If you subscribe to THIRD PARTY CUSTOMER STATUS, your webhook will receive the payload described in the third_party_customer_status_updated event.

For details of the payload structure, refer to the respective webhook event definition linked above.

Authentication: Bearer token required

Subscribe to real-time status updates for customers, virtual accounts, and payments. When you create a webhook, you'll receive JSON notifications at your specified endpoint whenever status changes occur. **Webhook Payload Mapping:** - If you subscribe to **CUSTOMER STATUS**, your webhook will receive the payload described in the [`customer_status_updated`](/api-reference/webhooks/webhook-customer-status-updated) event. - If you subscribe to **VBAN STATUS**, your webhook will receive the payload described in the [`virtual_account_status_updated`](/api-reference/webhooks/webhook-virtual-account-status-updated) event. - If you subscribe to **PAYMENT STATUS**, your webhook will receive the payload described in the [`payment_status_updated`](/api-reference/webhooks/webhook-payment-status-updated) event. - If you subscribe to **THIRD PARTY CUSTOMER STATUS**, your webhook will receive the payload described in the [`third_party_customer_status_updated`](/api-reference/webhooks/webhook-third-party-customer-status-updated) event. For details of the payload structure, refer to the respective webhook event definition linked above. **Authentication:** [Bearer token required](/api-guide/getting-started/authentication#oauth-20-authentication)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

endpointstringRequiredformat: "uri"

The HTTPS URL where webhook notifications will be sent. Must be a publicly accessible endpoint that can receive POST requests.

event_typeenumRequired

The type of event to subscribe to.

Allowed values:

Response

Webhook created successfully

idinteger

Unique subscription ID for this webhook subscription.

Errors

Webhook Payload Mapping:

If you subscribe to CUSTOMER STATUS, your webhook will receive the payload described in the customer_status_updated event.
If you subscribe to VBAN STATUS, your webhook will receive the payload described in the virtual_account_status_updated event.
If you subscribe to PAYMENT STATUS, your webhook will receive the payload described in the payment_status_updated event.
If you subscribe to THIRD PARTY CUSTOMER STATUS, your webhook will receive the payload described in the third_party_customer_status_updated event.

For details of the payload structure, refer to the respective webhook event definition linked above.

Authentication: Bearer token required

1	curl -X POST https://api.redpincompany.com/v1/webhooks \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"endpoint": "https://yourapp.com/webhooks/redpin",
6	"event_type": "PAYMENT STATUS"
7	}'