Create a Webhook

Create a webhook event

Parameters

The following parameters are available to create a webhook for various {user.company_name} events.

parameterdescriptionrequired

mid

The merchant id assigned by {user.company_name} or your merchant service provider (MSP)

Yes

name

Name of your event

Yes

uri

The uri that will receive the webhook message

Yes

event

Webhook event (see below)

Yes

content_type

No

header_key

No

header_value

No

Available Webhook Events:

  • sale.approved
  • sale.declined
  • auth.approved
  • auth.declined
  • capture.approved
  • capture.declined
  • refund.approved
  • refund.declined
  • void.approved
  • void.declined
  • dispute.new
  • dispute.won
  • dispute.lost
  • dispute.closed
  • deposit.new
  • boarded.approved
  • boarded.declined
JSON Example

The following JSON example provides test values to create a webhook. You can copy and replace these values in the transaction_data object in the Try it Out feature

"mid": "887728202",
"name": "MyWebhook",
"uri": "https://mywebhook.com",
"event": "sale.approved"

Response Codes

Language
Click Try It! to start a request and see the response here!