Skip to main content

Register Webhook

POST 
/b2b/webhooks

Register a new webhook endpoint to receive event notifications from Payward Embed.

When you register a webhook, you'll receive a secret in the response. This secret is base64-encoded and is used to verify webhook signatures. Store it securely — it is only returned once and cannot be retrieved again.

You can optionally specify enabled and events at registration time, or configure them later using the Update Webhook endpoint.

URL Requirements​

  • Must use HTTPS protocol
  • Maximum length: 2048 characters
  • Must be a valid URL format
  • Must have a valid host (not empty)
  • Host cannot be a protocol name (e.g., http, https, ftp, file, mailto, ssh, git, svn)
  • Path cannot start with // (indicates malformed URL)
  • Cannot contain credentials (e.g., https://user:pass@example.com is rejected)

Valid URL Examples​

  • https://example.com/webhook
  • https://example.com:8443/webhook

Invalid URL Examples​

  • http://example.com/webhook (HTTP not allowed)
  • https://https//example.com (malformed - host is "https")
  • https://user:pass@example.com/webhook (credentials not allowed)
  • invalid-url (not a valid URL)

Request​

Responses​

Webhook registered successfully