A webhook endpoint is a URL on your server that Payve posts events to. You add it in the dashboard.

Before you start

  • Your URL must use https and resolve to a public address. Payve does not deliver to localhost or private networks.
  • Your server must answer within 30 seconds, without a redirect.
  • Have somewhere safe to store the signing secret, such as your secret manager.
To receive sandbox events on your laptop, put a public HTTPS tunnel in front of your local server and register the tunnel’s URL.

Add the endpoint

1

Choose the environment

Sign in to the dashboard and switch to Sandbox or Live. The endpoint receives events from that environment only.
2

Open Webhooks

Go to Settings → Webhooks. You land on the Endpoints tab.
3

Enter your URL

Select Add endpoint and type your URL in Endpoint URL, for example https://yourapp.com/webhooks/payve.
4

Choose events

Leave Events to receive on All events, or open the list and tick the ones you want.
5

Save the signing secret

Select Add endpoint. The dashboard shows a Signing secret that starts with whsec_. Reveal it, copy it, and store it before you select Close.
The signing secret is shown once. Payve keeps it encrypted and never displays it again, in the dashboard or through the API. If you close the panel without copying it, delete the endpoint and add it again to get a new secret.
Your server uses the secret to prove each delivery came from Payve. See Verify signatures.

Events you can choose

Choose All events and filter by type in your code. You then receive new event types without coming back to change the endpoint.
The full payload for each event is in Webhook event object.

Pause an endpoint

Each endpoint has a switch. Turn it off and confirm Disable this endpoint? to stop deliveries. Turn it on again to resume. Nothing is deleted while an endpoint is off. Events raised during that time are not delivered to it later, so reconcile with the API when you turn it back on.

Delete an endpoint

Select the delete button on the endpoint and confirm Delete this endpoint?. Payve stops sending events to it. Past deliveries stay in the event log. A deleted endpoint cannot be restored. Adding the same URL again creates a new endpoint with a new signing secret.

More than one endpoint

You can add several endpoints in one environment. Each has its own signing secret and its own event selection, and each receives its own copy of an event.

Next

Verify signatures

Check that a delivery really came from Payve.

Track events

See what Payve sent and what your server answered.