Webhook reference
Status | Description |
|---|---|
Active | Everything is OK. |
Suspended | Something went wrong. Several attempts to send events to this registration failed. No further attempts will be made until registration is restarted. |
Restarting | We are attempting to restart this registration. An event must be successfully transmitted before the status will transition back to Active. |
Type | Description |
|---|---|
Push | Events will be pushed to a partner endpoint. A 200 OK response is expected in order for it to be considered successful. (Default) |
Poll | Events will be consumed by partner polling the events API periodically and calling acknowledge API method for each event successfully processed. |
File | Events will be sent to the partner via SFTP in a CSV file once per day |
Status | Description |
|---|---|
Pending | Event has been created, but no attempt to send it has been made yet |
Success | Event was successfully delivered to the registered URL |
Failed | We could not deliver the event to the registered URL. See the event logs for more detail on the failure reason. |
Format | Description |
|---|---|
Basic | Webhook is delivered with an object containing resource identifiers related to that event |
Extended | With this format you get everything in a 'Basic' event, in addition you will receive a 'Details' object containing various meta data pertaining to each resource. For example, on the ACH.Return.Received event you would receive the Return Code and Original Payment ID. |
