The webhook object

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

To receive webhook notifications, you must first register the URL where the webhook should be sent and the triggering event. When the event occurs, the API will send an HTTP request containing the notification to the specified URL. If a valid HTTP response is not received, the API will retry.

Attributes

`id`

string

Unique identifier for the webhook.

`type`

enum

The event type to be sent to this url.

Possible enum values

`payment.create`

A new payment was successfully created.

`payment.update`

A payment's status changed.

`account.create`

A new account was successfully created.

`account.update`

An account's status changed.

`entity.create`

A new entity was successfully created.

`entity.update`

An entity's status changed.

`account_verification.create`

A new account verification was successfully created.

`account_verification.update`

An account's verification status changed.

`payment_reversal.create`

A new payment reversal was successfully created.

`payment_reversal.update`

A payment's reversal status changed.

`connection.create`

A new connection was successfully created.

`connection.update`

A connection's status changed.

`url`

string

The HTTPS URL receiving the webhook event.

`auth_token`

string,null

Secret token for request validation. Will be sent as a base64 encoded string in the Authorization header of the webhook.

`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.

THE WEBHOOK OBJECT
{
  "id": "whk_cSGjA6d9N8y8R",
  "type": "payment.update",
  "url": "https://api.example.app/webhook",
  "auth_token": "md7UqcTSmvXCBzPORDwOkE",
  "metadata": null,
  "created_at": "2020-12-09T00:41:05.647Z",
  "updated_at": "2020-12-09T00:41:05.647Z"
}

Webhook event object

Possible enum values

`create`

`update`

WEBHOOK EVENT OBJECT
{
  "id": "pmt_jqFdSAQDtUPqx",
  "type": "payment.create",
  "op": "create"
}