Trigger Test Link Webhook Event
Trigger Test Link Webhook Event
Triggers a webhook event for a link, for testing purposes; works only for sandbox links.
URL
Request
Response
webhook_event
: string
required
The webhook event you want to trigger for a link.
Allowed values:
link.state_changed
transactions.updates_available
product.state_changed
link.product_refresh
webhook_idempotency_key
: string
required
Set this to a unique value that you can check against the delivered webhook payload (webhook_idempotency_key
).
id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
Responses
200
Successful Response
delivery_token
: string
400
Link missing webhook configuration.
error_code
: string
default: "link_error.bad_config"
Allowed values:
link_error.bad_config
error_message
: string
documentation_url
: string
403
Forbidden by link owner. The user did not give permission to access this data when linking or testing only supported for sandbox links.
error_code
: string
default: "link_error.forbidden_action"
Allowed values:
link_error.forbidden_action
error_message
: string
Error message
example: Accounts access not permitted
documentation_url
: string
404
Link not found.
error_code
: string
default: "link_error.not_found"
Allowed values:
link_error.not_found
error_message
: string
default: "Link not found."
documentation_url
: string
410
Link deleted.
error_code
: string
default: "link_error.deleted"
Allowed values:
link_error.deleted
error_message
: string
default: "This link was deleted at some earlier time."
documentation_url
: string
422
Link error.
error_code
: string
default: "link_error.bad_state"
Allowed values:
link_error.bad_state
error_message
: string
documentation_url
: string
link_error_code
: string
429
Rate limit exceeded.
error_code
: string
default: "api_error.rate_limit_exceeded"
Allowed values:
api_error.rate_limit_exceeded
error_message
: string
Error message
default: "Rate limit exceeded"
documentation_url
: string