Manage Webhook Details – Send Webhook Events for Phone Calls and Payment Status Events

Overview

Paytia allows you to configure webhooks so that payment and telephone call events can be automatically pushed from Paytia to your own systems.

Webhooks can be configured independently for:

• Payment events

• Phone call events

This allows your business systems to receive real-time updates when specific events occur within the Paytia platform.

For example, you can use webhooks to receive:

• Payment transaction outcomes.

• Payment status changes.

• Incoming call events.

• Call ringing events.

• Call delivery events.

• Payment capture events during a telephone call.

• Call recording file paths for storage or processing within your own systems.

Access Manage Webhook Details

Navigate to:

Settings
→ Manage webhook detail

Manage webhook detail

Choose your webhook event type

Paytia can push updates independently for payment and telephony events.

You can configure separate webhook plans for each function.

Payment

The Payment event type sends webhook notifications relating to payment transaction outcomes.

You can select which payment status events you want your endpoint to receive.

This allows your own applications, CRM, ERP or other business systems to react automatically when a payment status changes.

Phone call

The Phone call event type allows you to subscribe to telephony events generated during a Paytia call.

Depending on the events selected, this can include activity from the initial call ringing through to call delivery and payment capture events.

Phone call webhooks can also be used to receive call recording file paths, allowing call recordings to be referenced, retrieved or stored within your own systems where the Paytia service configuration supports call recording.

Add a new webhook

Select the Add Webhook button to create a new webhook plan.

This opens the Add Webhook Details page.

Use this page to configure the webhook events required by your business.

Webhook configuration fields

Fields marked with an asterisk * are mandatory where applicable.

Configure the endpoint URL

The Endpoint URL is the address within your application or integration that will receive webhook events from Paytia.

For example, your receiving application may expose an endpoint dedicated to:

• Payment updates.

• Telephone call events.

• CRM updates.

• Order status changes.

• Call recording information.

Your endpoint should be able to receive and process the webhook requests generated by the selected Paytia events.

Configure the authentication token

The Auth token allows you to configure a security value that is included in the header of webhook requests sent by Paytia.

Your receiving application can use this value to help validate that the webhook request is expected.

The authentication token should be treated as sensitive configuration information.

Do not expose your token within publicly accessible source code, support tickets or documentation.

Select the webhook events

Under Transaction State events, select the events that your system needs to receive.

The available events will depend on the webhook type selected.

For a Payment webhook, these may relate to different payment transaction states or outcomes.

For a Phone call webhook, these may relate to different stages of the telephone call and associated payment capture process.

Only select events that your receiving system needs to process.

This makes webhook handling easier and reduces unnecessary event traffic.

Webhook plan example

Once configured, your webhook plan will appear within the Manage Webhook Details page.

Control your webhook plan

Each webhook plan can be controlled from the webhook management page.

Status

The webhook status indicates whether the plan is currently active.

• Green – Webhook is enabled.

• Red – Webhook is disabled.

A disabled webhook plan will not send events to the configured endpoint.

Edit

Select Edit to change the webhook plan configuration.

For example, you may need to change:

• Endpoint URL.

• Authentication token.

• Gateway.

• Gateway account.

• Selected webhook events.

Delete

Select Delete to permanently remove the webhook plan.

Only delete a plan if it is no longer required.

Webhook settings

Additional webhook behaviour can be configured through the webhook settings.

Webhook retry controls

Webhook retry controls determine how Paytia should respond when a webhook cannot be successfully delivered to your endpoint.

You can configure how failed webhook deliveries should be retried.

Retry controls are useful where the receiving system may be temporarily unavailable because of:

• Network problems.

• Application downtime.

• Maintenance.

• Temporary endpoint errors.

• Server availability issues.

Your receiving system should also be designed to handle the possibility of a webhook being delivered more than once following a retry.

Recommended webhook implementation

When integrating your own systems with Paytia webhooks:

• Use an HTTPS endpoint.

• Protect your authentication token.

• Validate incoming webhook requests.

• Return an appropriate successful HTTP response when the event has been accepted.

• Log received webhook events within your application.

• Handle temporary endpoint failures.

• Design your integration so that receiving the same event more than once does not cause duplicate business actions.

• Subscribe only to events required by your application.

Example webhook flow

A typical Paytia webhook flow is:

Payment or telephone event occurs in Paytia
↓
Paytia checks subscribed webhook plans
↓
Relevant event is generated
↓
Webhook is sent to the configured Endpoint URL
↓
Authentication information is included in the request
↓
Customer application receives the event
↓
Customer application processes the event
↓
Webhook delivery succeeds

If delivery fails:

Webhook delivery fails
↓
Paytia webhook retry settings are applied
↓
Delivery is attempted again according to the configured retry controls

So to wrap up

Paytia webhooks allow businesses to automatically receive payment status and telephone call events within their own applications and business systems.

Payment and phone call webhooks can be configured independently, allowing you to select the exact events required by your integration.

Each webhook plan defines where Paytia sends the event, how the request is authenticated and which events should trigger a notification.

Webhook retry controls can also be used to manage temporary delivery failures and improve the reliability of integrations between Paytia and your own systems.