GuidesAPI ReferencePinch Website
HomeGuidesAPI Reference
GuidesAPI ReferencePinch WebsitePinch PortalLog In
API Reference
Pinch Portal
Start typing to search…

Create or Update Webhook

post
https://api.getpinch.com.au/test/webhooks
Body Params
string

Webhook Id in wbk_XXXXXXXXXXXXXX format

string
required

Callback URI

string
enum
Defaults to pascal-case

The JSON casing format applied to the payload when sending the webhook

Allowed:
eventTypes
array of strings

List of event types to subscribe to. Leave empty to subscribe to all events. See Events page for list of available event types.

eventTypes
boolean
Defaults to false

When enabled, this webhook will receive events for all managed merchants under this account in addition to events for this account.

Responses

Updated 9 months ago

Language
Credentials
OAuth2
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago