Webhooks

Test and resume webhook endpoint

Tests the endpoint before resuming a manually paused webhook.

post/api/v1/webhooks/{id}/resume

Path parameters

idstring required

Resource ID returned by the matching create or list endpoint.

Response

Webhook resumed after a successful test delivery

successboolean required

statusCodeinteger required

Example response

{
  "success": true,
  "statusCode": 200,
  "webhook": {
    "id": "42",
    "url": "https://example.com/webhooks/xquik",
    "eventTypes": [
      "tweet.new",
      "tweet.reply"
    ],
    "isActive": true,
    "deliveryStatus": "active",
    "failureHardCap": 200,
    "createdAt": "2025-01-15T12:00:00Z"
  }
}

Changes

Changed in 2 of the 19 revisions of this API.96

Aug 12, 20265d4938bb7de372See the full diff
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new closed enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new expired enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_complete_replies_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_request enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_output_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_reply_options enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new login_service_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new missing_url enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new too_many_tweets enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
Aug 12, 20264da209b29df824See the full diff
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_gone enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new coverage_cursor_unavailable enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the allOf[Error]/error/oneOf[subschema #2: StructuredError]/code response property for the response status 429
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #1: LegacyErrorCode]/ response property for the response status default
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status 404
  response-property-enum-value-added
- ●
  added the new invalid_coverage_cursor enum value to the error/oneOf[subschema #2: StructuredError]/code response property for the response status default
  response-property-enum-value-added

Full history