Webhook events

Shuttle generates webhooks for the following events.

action	description
ACCOUNT.CREATED	An account is created
ACCOUNT.UPDATE	An account is updated
CAPTURE.SUCCESS	An authorisation was captured successfully
CAPTURE.FAILED	An authorisation capture failed
CAPTURE.PENDING	An authorisation capture is pending
CAPTURE.UNRESOLVED	An authorisation capture status is unresolved
CHANNEL.CREATED	A channel is created
CHANNEL.UPDATE	A channel is updated
CHANNEL.ARCHIVE	A channel is archived
CHARGE.CREATED	A charge is created
CHARGE.UPDATE	A charge is updated
CHARGE.WRITTENOFF	A charge is written off
CHARGE.COMPLETE	A charge is completed
CONTRACT.START	A contract is started
CONTRACT.UPDATE	A contract is updated
CONTRACT.COMPLETE	A contract is completed
CONTRACT.NOTE	A note is added to a contract
DESIGNATION.CREATED	A designation is created
DESIGNATION.UPDATE	A designation is updated
DESIGNATION.ARCHIVE	A designation is archived
DESIGNATION_ROUTE.CREATED	A designation routing rule is created
DESIGNATION_ROUTE.UPDATE	A designation routing rule is updated
DESIGNATION_ROUTE.ARCHIVE	A designation routing rule is archived
GATEWAY.CREATED	A gateway is created
GATEWAY.UPDATE	A gateway is updated
GATEWAY.ARCHIVE	A gateway is archived
INITIATIVE.CREATED	An initiative is created
INITIATIVE.UPDATE	An initiative is updated
INITIATIVE.ARCHIVE	An initiative is archived
INSTANCE.CREATED	A new instance is created
INSTANCE.UPDATE	An existing instance is updated
INSTANCE.ARCHIVE	An instance is terminated
LEGAL_ENTITY.CREATED	A legal entity is created
LEGAL_ENTITY.UPDATE	A legal entity is updated
LEGAL_ENTITY.ARCHIVE	A legal entity is archived
LEGAL_ENTITY_ROUTE.CREATED	A payment routing rule is created
LEGAL_ENTITY_ROUTE.UPDATE	A payment routing rule is updated
LEGAL_ENTITY_ROUTE.ARCHIVE	A payment routing rule is replaced
PAYMENT.SUCCESS	A payment was successful
PAYMENT.FAILED	A payment failed
PAYMENT.PENDING	A payment is pending
PAYMENT.UNRESOLVED	A payment status is unresolved
PAYMENT.UPDATE	A payment is updated
PAYMENT_LINK.CREATED	Payment link has been created
PAYMENT_LINK.UPDATE	Payment link details have been updated
PAYMENT_LINK.PENDING	Payment submitted, however awaiting authorization
PAYMENT_LINK.FAILED	Payment was declined, after previously being pending
PAYMENT_LINK.COMPLETE	Payment successful
PAYMENT_LINK.EXPIRED	Payment link expired
PAYMENT_LINK.ARCHIVE	Payment link archived (ie deleted)
PAYMENT_METHOD.SINGLEUSE	A payment method is set for single use
PAYMENT_METHOD.ACTIVE	A payment method is active
PAYMENT_METHOD.FAILED	A payment method failed
PAYMENT_METHOD.PENDING	A payment method is pending
PAYMENT_METHOD.UPDATE	A payment method is updated
PAYMENT_METHOD.ARCHIVE	A payment method is archived
REFUND.SUCCESS	A refund was successful
REFUND.FAILED	A refund failed
REFUND.PENDING	A refund is pending
REFUND.UNRESOLVED	A refund status is unresolved
TEAM.CREATED	A team is created
TEAM.UPDATE	A team is updated
TEAM.ARCHIVE	A team is archived
VOID.SUCCESS	A void was successful
VOID.FAILED	A void failed

Webhooks are POST requests to your configured URL using the attached format.

ACCOUNT.CREATED

Sent when a new account is created. Every payment is made against an account, so if you don’t pass an account identifier on the API you may receive this for each payment: Shuttle creates a new account for each one.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value ACCOUNT.CREATED
account	the account this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "ACCOUNT.CREATED",
    "account": "acc_11842_10004",
    "created": "2020-04-08T11:05:56"
}

ACCOUNT.UPDATE

Sent when an existing account is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value ACCOUNT.UPDATE
account	the account this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "ACCOUNT.UPDATE",
    "account": "acc_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CAPTURE.SUCCESS

Sent when an authorisation was captured successfully. This only applies to AUTH / CAPTURE scenarios, not where the AUTH and CAPTURE are at the same time.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CAPTURE.SUCCESS
capture	the capture this event refers to
transaction	the authorisation transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CAPTURE.SUCCESS",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CAPTURE.FAILED

Sent when an authorisation failed to capture.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CAPTURE.FAILED
capture	is the capture transaction this event refers to
transaction	is the authorisation transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CAPTURE.FAILED",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CAPTURE.PENDING

Sent when an authorisation was instructed for capture but is still in progress, you will receive a CAPTURE.SUCCESS or CAPTURE.FAILED once the status of the capture is known.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CAPTURE.PENDING
capture	is the capture transaction this event refers to
transaction	is the authorisation transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CAPTURE.PENDING",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CAPTURE.UNRESOLVED

Sent when a capture is unresolved, this means it was sent to the gateway but its not clear if the capture was processed or not. Please note, Shuttle will try to automatically reconcile the transaction with the gateway immediately, then after 1 minute, and again after 15 minutes. In some cases however it will require the merchant to log into their gateway to see if the funds were received.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CAPTURE.UNRESOLVED
capture	is the capture transaction this event refers to
transaction	is the authorisation transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CAPTURE.UNRESOLVED",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CHARGE.CREATED

Sent when a recurring payment contract has a new charge raised.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHARGE.CREATED
contract	the contract this charge belongs to
charge	the charge this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHARGE.CREATED",
    "contract": "co_11842_10004",
    "charge": "cg_11842_10042",
    "created": "2020-04-08T11:05:56"
}

CHARGE.UPDATE

Sent when a recurring payment contract has a charge updated, eg the amount or due date.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHARGE.UPDATE
contract	the contract this charge belongs to
charge	the charge this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHARGE.UPDATE",
    "contract": "co_11842_10004",
    "charge": "cg_11842_10042",
    "created": "2020-04-08T11:05:56"
}

CHARGE.WRITTENOFF

Sent for a recurring payment contract, when the unpaid amount of a charge is voided. If this is sent you will not receive a CHARGE.COMPLETE, as the charge will never be fully paid.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHARGE.WRITTENOFF
contract	the contract this charge belongs to
charge	the charge this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHARGE.WRITTENOFF",
    "contract": "co_11842_10004",
    "charge": "cg_11842_10042",
    "created": "2020-04-08T11:05:56"
}

CHARGE.COMPLETE

Sent for a recurring payment contract, when a charge is fully paid. This will not be sent if the charge is voided, you will receive a CHARGE.WRITTENOFF.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHARGE.COMPLETE
contract	the contract this charge belongs to
charge	the charge this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHARGE.COMPLETE",
    "contract": "co_11842_10004",
    "charge": "cg_11842_10042",
    "created": "2020-04-08T11:05:56"
}

CONTRACT.START

Sent when a recurring payment contract is activated successfully (by default, a contract with an initial payment will not start unless the initial payment successful)

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CONTRACT.START
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CONTRACT.START",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CONTRACT.UPDATE

Sent when a recurring payment contract is update (eg next_charge, payment_method, status, last_transaction). Its worth noting we may fire two of these for each recurring payment, once to indicate a new charge is present (updating next_charge), and a second time when the new charge is paid (updating last_transaction).

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CONTRACT.UPDATE
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CONTRACT.UPDATE",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CONTRACT.COMPLETE

Sent when a recurring payment contract status transitions to COMPLETED, CANCELLED or FAILED.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CONTRACT.COMPLETE
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CONTRACT.COMPLETE",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CONTRACT.NOTE

Sent when a recurring payment has a note (ie comment) added or updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CONTRACT.NOTE
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CONTRACT.NOTE",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

PAYMENT.SUCCESS

Sent when payment was completed successfully. This may be an AUTH or AUTH/CAPTURE.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT.SUCCESS
payment	is the payment this event refers to
transaction	is the transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT.SUCCESS",
    "payment": "pay_11842_10009",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

PAYMENT.FAILED

Sent when a payment was declined.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT.FAILED
payment	is the payment this event refers to
transaction	is the transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT.FAILED",
    "payment": "pay_11842_10009",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

PAYMENT.PENDING

Sent when a payment has started processing, but the success status is not available yet (eg: for Direct Debit). You will receive a PAYMENT.SUCCESS or PAYMENT.FAILED webhook once completed.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT.PENDING
payment	is the payment this event refers to
transaction	is the transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT.PENDING",
    "payment": "pay_11842_10009",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

PAYMENT.UNRESOLVED

Sent when a payment is unresolved, this means it was sent to the gateway but its not clear if the transaction was processed or not. Please note, Shuttle will try to automatically reconcile the transaction with the gateway immediately, then after 1 minute, and again after 15 minutes. In some cases however it will require the merchant to log into their gateway to see if the funds were received.

Once the transaction is resolved (automatically by Shuttle or manually by the user) you would then get a PAYMENT.SUCCESS or PAYMENT.FAILED webhook.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT.UNRESOLVED
payment	is the payment this event refers to
transaction	is the transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT.UNRESOLVED",
    "payment": "pay_11842_10009",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

PAYMENT.UPDATE

Sent when a payment is updated, for exampled refunded.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT.UPDATE
payment	is the payment this event refers to
transaction	is the transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT.UPDATE",
    "payment": "pay_11842_10009",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.CREATED

Sent when a payment link has been created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.CREATED
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.CREATED",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.UPDATE

Sent when payment link details have been updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.UPDATE
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.UPDATE",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.PENDING

Sent when a payment has been submitted through a payment link, however it is awaiting authorization.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.PENDING
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
contract	is the contract this event refers to
transaction	is the transaction this event refers to
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.PENDING",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "contract": "co_11842_10004",
    "transaction": "tr_11842_10009",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.FAILED

Sent when a payment was declined, after previously being pending.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.FAILED
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
contract	is the contract this event refers to
transaction	is the transaction this event refers to
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.FAILED",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "contract": "co_11842_10004",
    "transaction": "tr_11842_10009",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.COMPLETE

Sent when a payment through a payment link is successful.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.COMPLETE
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
contract	is the contract this event refers to
transaction	is the transaction this event refers to
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.COMPLETE",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "contract": "co_11842_10004",
    "transaction": "tr_11842_10009",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.EXPIRED

Sent when a payment link has expired.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.EXPIRED
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.EXPIRED",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "created": "2020-04-08T11:05:56"
}

PAYMENT_LINK.ARCHIVE

Sent when a payment link has been archived (i.e., deleted).

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_LINK.ARCHIVE
payment_link	is the payment link this event refers to
state	the custom state data set on the payment link, if any
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_LINK.ARCHIVE",
    "payment_link": "pl_11842_10009",
    "state": { "order_id": "ORD-1001" },
    "created": "2020-04-08T11:05:56"
}

PAYMENT_METHOD.SINGLEUSE

Sent when payment method is created for SINGLEUSE.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_METHOD.SINGLEUSE
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_METHOD.SINGLEUSE",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_METHOD.ACTIVE

Sent when payment method created (and saved for reuse) or transitions from PENDING to ACTIVE (saved for reuse).

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_METHOD.ACTIVE
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_METHOD.ACTIVE",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_METHOD.FAILED

Sent when payment method transitions from PENDING to FAILED, or failed tokenisation.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_METHOD.FAILED
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_METHOD.FAILED",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_METHOD.PENDING

Sent when payment method was created in a PENDING status (eg it is still being authorised).

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_METHOD.PENDING
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_METHOD.PENDING",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_METHOD.UPDATE

Sent when payment method is updated. This will trigger each time the payment method is used, or updated with new details.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_METHOD.UPDATE
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_METHOD.UPDATE",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

PAYMENT_METHOD.ARCHIVE

Sent when tokenised payment method is “deleted”. This is the transition from an ACTIVE to an INACTIVE status.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value PAYMENT_METHOD.ARCHIVE
payment_method	is the payment method this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "PAYMENT_METHOD.ARCHIVE",
    "payment_method": "pm_11842_10009",
    "created": "2020-04-08T11:05:56"
}

REFUND.SUCCESS

Sent when a refund was completed successfully.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value REFUND.SUCCESS
refund	is the refund transaction this event refers to
capture	(optional) is the capture transaction this event refers to, if an AUTH / CAPTURE
transaction	is the payment (or initial authorisation) transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "REFUND.SUCCESS",
    "refund": "ref_11842_10027",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

REFUND.FAILED

Sent when a refund was declined. Examples include if the initial transaction was too long ago (varies gateway by gateway), or the refund has already been refunded via the gateway.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value REFUND.FAILED
refund	is the refund transaction this event refers to
capture	(optional) is the capture transaction this event refers to, if an AUTH / CAPTURE
transaction	is the payment (or initial authorisation) transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "REFUND.FAILED",
    "refund": "ref_11842_10027",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

REFUND.PENDING

Sent when a refund has started processing, but the success status is not available yet. You will receive a REFUND.SUCCESS or REFUND.FAILED webhook once completed.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value REFUND.PENDING
refund	is the refund transaction this event refers to
capture	(optional) is the capture transaction this event refers to, if an AUTH / CAPTURE
transaction	is the payment (or initial authorisation) transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "REFUND.PENDING",
    "refund": "ref_11842_10027",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

REFUND.UNRESOLVED

Sent when a refund is unresolved, this means it was sent to the gateway but its not clear if the refund was processed or not. Please note, Shuttle will try to automatically reconcile the transaction with the gateway immediately, then after 1 minute, and again after 15 minutes. In some cases however it will require the merchant to log into their gateway to see if the funds were sent.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value REFUND.UNRESOLVED
refund	is the refund transaction this event refers to
capture	(optional) is the capture transaction this event refers to, if an AUTH / CAPTURE
transaction	is the payment (or initial authorisation) transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "REFUND.UNRESOLVED",
    "refund": "ref_11842_10027",
    "capture": "ca_11842_10010",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

VOID.SUCCESS

Sent when an authorisation was voided successfully.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value VOID.SUCCESS
transaction	is the authorisation transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "VOID.SUCCESS",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

VOID.FAILED

Sent when an authorisation failed voiding.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value VOID.FAILED
transaction	is the authorisation transaction this event refers to
contract	the contract this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "VOID.FAILED",
    "transaction": "tr_11842_10009",
    "contract": "co_11842_10004",
    "created": "2020-04-08T11:05:56"
}

CHANNEL.CREATED

Sent when a new channel is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHANNEL.CREATED
channel	is the channel this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHANNEL.CREATED",
    "channel": "ch_11842_10009",
    "created": "2020-04-08T11:05:56"
}

CHANNEL.UPDATE

Sent when a channel is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHANNEL.UPDATE
channel	is the channel this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHANNEL.UPDATE",
    "channel": "ch_11842_10009",
    "created": "2020-04-08T11:05:56"
}

CHANNEL.ARCHIVE

Sent when a channel is archived. No further payments will be processed via a channel once archived.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value CHANNEL.ARCHIVE
channel	is the channel this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "CHANNEL.ARCHIVE",
    "channel": "ch_11842_10009",
    "created": "2020-04-08T11:05:56"
}

DESIGNATION.CREATED

Sent when a new designation is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value DESIGNATION.CREATED
designation	is the designation this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "DESIGNATION.CREATED",
    "designation": "des_11842_10009",
    "created": "2020-04-08T11:05:56"
}

DESIGNATION.UPDATE

Sent when a designation is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value DESIGNATION.UPDATE
designation	is the designation this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "DESIGNATION.UPDATE",
    "designation": "des_11842_10009",
    "created": "2020-04-08T11:05:56"
}

DESIGNATION.ARCHIVE

Sent when a designation is archived. No further payments will be processed via a designation once archived.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value DESIGNATION.ARCHIVE
designation	is the designation this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "DESIGNATION.ARCHIVE",
    "designation": "des_11842_10009",
    "created": "2020-04-08T11:05:56"
}

DESIGNATION_ROUTE.CREATED

Sent when a new designation route is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value DESIGNATION_ROUTE.CREATED
designation_route	is the designation route this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "DESIGNATION_ROUTE.CREATED",
    "designation_route": "dc_11842_10009",
    "created": "2020-04-08T11:05:56"
}

DESIGNATION_ROUTE.UPDATE

Sent when a designation route is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value DESIGNATION_ROUTE.UPDATE
designation_route	is the designation route this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "DESIGNATION_ROUTE.UPDATE",
    "designation_route": "dc_11842_10009",
    "created": "2020-04-08T11:05:56"
}

DESIGNATION_ROUTE.ARCHIVE

Sent when a designation route is archived. No further payments will be processed via a designation route once archived.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value DESIGNATION_ROUTE.ARCHIVE
designation_route	is the designation route this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "DESIGNATION_ROUTE.ARCHIVE",
    "designation_route": "dc_11842_10009",
    "created": "2020-04-08T11:05:56"
}

GATEWAY.CREATED

Sent when a new processor connection is made.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value GATEWAY.CREATED
gateway	is the gateway this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "GATEWAY.CREATED",
    "gateway": "gw_11842_10009",
    "created": "2020-04-08T11:05:56"
}

GATEWAY.UPDATE

Sent when a processor connection is updated.

Note: This currently will also fire every time an OAUTH access token is updated, which may be quite regularly.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value GATEWAY.UPDATE
gateway	is the gateway this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "GATEWAY.UPDATE",
    "gateway": "gw_11842_10009",
    "created": "2020-04-08T11:05:56"
}

GATEWAY.ARCHIVE

Sent when a processor is disconnected. No further payments will be processed via a gateway once disconnected.

Note: Not routing any payments to the GATEWAY is different from disconnecting it.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value GATEWAY.ARCHIVE
gateway	is the gateway this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "GATEWAY.ARCHIVE",
    "gateway": "gw_11842_10009",
    "created": "2020-04-08T11:05:56"
}

INITIATIVE.CREATED

Sent when a new initiative is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value INITIATIVE.CREATED
initiative	is the initiative this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "INITIATIVE.CREATED",
    "initiative": "in_11842_10009",
    "created": "2020-04-08T11:05:56"
}

INITIATIVE.UPDATE

Sent when an initiative is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value INITIATIVE.UPDATE
initiative	is the initiative this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "INITIATIVE.UPDATE",
    "initiative": "in_11842_10009",
    "created": "2020-04-08T11:05:56"
}

INITIATIVE.ARCHIVE

Sent when an initiative is archived. No further payments will be processed via an initiative once archived.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value INITIATIVE.ARCHIVE
initiative	is the initiative this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "INITIATIVE.ARCHIVE",
    "initiative": "in_11842_10009",
    "created": "2020-04-08T11:05:56"
}

INSTANCE.CREATED

Sent when a new instance is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value INSTANCE.CREATED
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "INSTANCE.CREATED",
    "created": "2020-04-08T11:05:56"
}

INSTANCE.UPDATE

Sent when an existing instance is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value INSTANCE.UPDATE
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "INSTANCE.UPDATE",
    "created": "2020-04-08T11:05:56"
}

INSTANCE.ARCHIVE

Sent when an instance is terminated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value INSTANCE.ARCHIVE
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "INSTANCE.ARCHIVE",
    "created": "2020-04-08T11:05:56"
}

LEGAL_ENTITY.CREATED

Sent when a legal entity is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value LEGAL_ENTITY.CREATED
legal_entity	is the legal entity this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "LEGAL_ENTITY.CREATED",
    "legal_entity": "le_11842_10009",
    "created": "2020-04-08T11:05:56"
}

LEGAL_ENTITY.UPDATE

Sent when a legal entity is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value LEGAL_ENTITY.UPDATE
legal_entity	is the legal entity this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "LEGAL_ENTITY.UPDATE",
    "legal_entity": "le_11842_10009",
    "created": "2020-04-08T11:05:56"
}

LEGAL_ENTITY.ARCHIVE

Sent when a legal entity is archived.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value LEGAL_ENTITY.ARCHIVE
legal_entity	is the legal entity this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "LEGAL_ENTITY.ARCHIVE",
    "legal_entity": "le_11842_10009",
    "created": "2020-04-08T11:05:56"
}

LEGAL_ENTITY_ROUTE.CREATED

Sent when a payment routing rule is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value LEGAL_ENTITY_ROUTE.CREATED
legal_entity_route	is the payment routing rule this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "LEGAL_ENTITY_ROUTE.CREATED",
    "legal_entity_route": "ler_11842_10009",
    "created": "2020-04-08T11:05:56"
}

LEGAL_ENTITY_ROUTE.UPDATE

Sent when a payment routing rule is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value LEGAL_ENTITY_ROUTE.UPDATE
legal_entity_route	is the payment routing rule this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "LEGAL_ENTITY_ROUTE.UPDATE",
    "legal_entity_route": "ler_11842_10009",
    "created": "2020-04-08T11:05:56"
}

LEGAL_ENTITY_ROUTE.ARCHIVE

Sent when a payment routing rule is replaced.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value LEGAL_ENTITY_ROUTE.ARCHIVE
legal_entity_route	is the payment routing rule this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "LEGAL_ENTITY_ROUTE.ARCHIVE",
    "legal_entity_route": "ler_11842_10009",
    "created": "2020-04-08T11:05:56"
}

TEAM.CREATED

Sent when a team is created.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value TEAM.CREATED
team	is the team this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "TEAM.CREATED",
    "team": "t_11842_10009",
    "created": "2020-04-08T11:05:56"
}

TEAM.UPDATE

Sent when a team is updated.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value TEAM.UPDATE
team	is the team this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "TEAM.UPDATE",
    "team": "t_11842_10009",
    "created": "2020-04-08T11:05:56"
}

TEAM.ARCHIVE

Sent when a team is archived.

Field	Description
key	a unique identifier for this message, you should support receiving the same webhook multiple times
application	is the ID of the application in the developer portal
instance_key	is the instance key passed when setting up the instance
client	our internal ID for the instance key
action	the value TEAM.ARCHIVE
team	is the team this event refers to
created	when the webhook was initiated

POST {{your_webhook_url}}
content-type: application/json
Body:
{
    "key": "11842_1586343957346_5258502bcde56ad8",
    "application": "1186_6134",
    "instance_key": "B73A-20E5",
    "client": "11842",
    "action": "TEAM.ARCHIVE",
    "team": "t_11842_10009",
    "created": "2020-04-08T11:05:56"
}