Add Webhooks

post

https://testapi.payarc.net/v1/webhooks

Our platform uses webhooks to notify your system of important events as they happen. When an event occurs, we send an HTTP POST request to a URL you provide, containing a JSON payload with event details. You can use these webhooks to automate workflows, sync data, or trigger downstream processing.

Body Params

event_types

array of strings

required

Event that will trigger the web hook. One of those values: invoice.created, charge.created, subscription.created, subscription.updated, plan.created, plan.updated, plan.deleted, discount.created, discount.deleted, customer.created, customer.updated, customer.deleted, customer.card.added, customer.card.updated, customer.card.deleted, dispute.created, dispute.updated, refund.created, token.created, charge.captured charge.voided, subscription.cancelled, invoice.charge.success, invoice.charge.failed, dispute.won, dispute.lost, order.created, order.canceled, order.charged, order.charged.failure

event_types*

url

string

required

url of the resouce that will be invoked when event ocurs

active

string

Defaults to active

if present value is active

Headers

string

required

Defaults to application/json

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Type

string

required

Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

201201

422422