Webhooks
Create a Webhook
Webhooks
Create a Webhook
POST
/
webhooks
Creating a new Webhook means registering a URL to receive updates for a specific event type. Once a resource is created or updated, your application will be notified via an HTTPS POST request with the event information.
Body
type
enum
requiredThe event type to be sent to this URL. See Webhook Event Types.
url
string
requiredThe URL receiving the Webhook event.
When testing your integration in a local environment, we recommend utilizing the following technologies for a seamless developer experience with Webhooks:
- https://webhook.site – to debug the Webhook payload from Method.
- https://ngrok.com – to create a reverse proxy to your local development environment.
auth_token
string
Secret token for request validation. Will be sent as a base64 encoded string in the Authorization header of the Webhook. This can be used by your application to ensure the integrity of incoming Webhook events.
expand_event
boolean
Whether to expand the event object in the Webhook payload. (default: false)
Returns
Returns the newly created Webhook object.