{
  "id": "whk_cSGjA6d9N8y8R",
  "type": "payment.update",
  "url": "https://reference.example.app/webhook",
  "metadata": null,
  "created_at": "2020-12-09T00:41:05.647Z",
  "updated_at": "2020-12-09T00:41:05.647Z"
}
{
  "id": "pmt_jqFdSAQDtUPqx",
  "type": "payment.update",
  "path": "/payments/pmt_jqFdSAQDtUPqx"
}

Webhooks allow the Method API to notify your application when certain events occur.

To receive Webhook notifications, create a Webhook by registering a URL pointing to your application where triggered events should be sent to. This URL is where Method will send event information in an HTTPS POST request.

Handling webhooks

A Webhook event is considered successfully delivered when the corresponding URL endpoint responds with an HTTP status code of 200 within 5 seconds.

If the criteria is not met, Method will reattempt 4 more times with each new attempt being delayed according to an exponential backoff algorithm, where the delay period between each attempt exponentially increases.

Webhooks that consistently fail to respond with a 200 will automatically be disabled.

Webhook Objects

id
string

Unique identifier for the Webhook.

type
enum

The event type to be sent to this URL. See Webhook Event Types.

url
string

The URL receiving the webhook event.

metadata
object | null

Additional data provided during creation. See metadata

created_at
string

Timestamp of when the Webhook was created.

updated_at
string

Timestamp of when the Webhook was last updated.

Webhook event object

id
string

The identifier of the resource modified.

type
string

The event type. See Webhook Event Types.

path
string

The URL path pointing to the affected resource. Make a HTTP GET request to this path to retrieve the resource.

Webhook Event Types

NameDescription
account.createA new Account was successfully created.
account.updateAn Account has been updated.
sensitive.createA new Sensitive was successfully created.
sensitive.updateAn Sensitive has been updated.
account_verification_session.createA new AccountVerificationSession was successfully created.
account_verification_session.updateAn AccountVerificationSession has been updated.
balance.createA new Balance was successfully created.
balance.updateA Balance has been updated.
card.createA new Card was successfully created.
card.updateA Card has been updated.
connect.createA new Connect was successfully created.
connect.updateA Connect has been updated.
credit_score.createA new CreditScore was successfully created.
credit_score.updateA CreditScore has been updated.
entity.createA new Entity was successfully created.
entity.updateAn Entity has been updated.
entity_verification_session.createA new EntityVerificationSession was successfully created.
entity_verification_session.updateAn EntityVerificationSession has been updated.
identity.createA new Identity was successfully created.
identity.updateAn Identity has been updated.
payment.createA new Payment was successfully created.
payment.updateA Payment has been updated.
payment_reversal.createA new PaymentReversal was successfully created.
payment_reversal.updateA PaymentReversal has been updated.
payoff.createA new Payoff was successfully created.
payoff.updateA Payoff has been updated.
product.createA new Product was successfully created.
product.updateA Product has been updated.
report.createA new Report was successfully created.
report.updateA Report has been updated.
subscription.createA new Subscription was successfully created.
subscription.updateA Subscription has been updated.
transaction.createA new Transaction was successfully created.
transaction.updateA Transaction has been updated.
update.createA new Update was successfully created.
update.updateAn Update has been updated.
{
  "id": "whk_cSGjA6d9N8y8R",
  "type": "payment.update",
  "url": "https://reference.example.app/webhook",
  "metadata": null,
  "created_at": "2020-12-09T00:41:05.647Z",
  "updated_at": "2020-12-09T00:41:05.647Z"
}
{
  "id": "pmt_jqFdSAQDtUPqx",
  "type": "payment.update",
  "path": "/payments/pmt_jqFdSAQDtUPqx"
}