YOyoco
Webhooks

Send a test webhook event for a subscription

Changed on

Send a test webhook event for a subscription

Required scope: application/webhooks:write

post/v1/webhooks/subscriptions/{subscription_id}/test

Request

  • Base URL
    https://api.yoco.com
  • Auth
    HTTP bearer

Path parameters

subscription_idstring required

The unique identifier of the subscription.

Request body

event_type'item_category.created' | 'item_category.deleted' | 'item_category.updated' | 'item.created' | 'item.deleted' | 'item.updated' | 'order.cancelled' | 'order.completed' | 'order.created' | 'order.updated' | 'payment.created' | 'payment.refunded' required

Example request

{
  "event_type": "payment.created"
}

Response

Successful Response

message_idstring required

The unique message identifier of the webhook event.

Example response

{
  "message_id": "msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"
}

Changes

  • 47cea4404cf5Revision changes
    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new content_too_large enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

    • warning

      added the new unsupported_media_type enum value to the /// response property for the response status

  • 0696ca936043Revision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the /// response property for the response status

    • warning

      added the new conflict enum value to the /// response property for the response status

    • warning

      added the new conflict enum value to the /// response property for the response status

    • warning

      added the new conflict enum value to the /// response property for the response status

    • warning

      added the new conflict enum value to the /// response property for the response status