jQuery API

.ajaxSuccess()

.ajaxSuccess( handler(event, XMLHttpRequest, ajaxOptions) ) Returns: jQuery

Description: Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.

  • version added: 1.0.ajaxSuccess( handler(event, XMLHttpRequest, ajaxOptions) )

    handler(event, XMLHttpRequest, ajaxOptions)The function to be invoked.

Whenever an Ajax request completes successfully, jQuery triggers the ajaxSuccess event. Any and all handlers that have been registered with the .ajaxSuccess() method are executed at this time.

To observe this method in action, we can set up a basic Ajax load request:

<div class="trigger">Trigger</div>
<div class="result"></div>
<div class="log"></div>

We can attach our event handler to any element:

$('.log').ajaxSuccess(function() {
  $(this).text('Triggered ajaxSuccess handler.');
});

Now, we can make an Ajax request using any jQuery method:

$('.trigger').click(function() {
  $('.result').load('ajax/test.html');
});

When the user clicks the element with class trigger and the Ajax request completes successfully, the log message is displayed.

Note: Because .ajaxSuccess() is implemented as a method of jQuery object instances, we can use the this keyword as we do here to refer to the selected elements within the callback function.

All ajaxSuccess handlers are invoked, regardless of what Ajax request was completed. If we must differentiate between the requests, we can use the parameters passed to the handler. Each time an ajaxSuccess handler is executed, it is passed the event object, the XMLHttpRequest object, and the settings object that was used in the creation of the request. For example, we can restrict our callback to only handling events dealing with a particular URL:

Note: You can get the returned ajax contents by looking at xhr.responseXML or xhr.responseText for xml and html respectively.

$('.log').ajaxSuccess(function(e, xhr, settings) {
  if (settings.url == 'ajax/test.html') {
    $(this).text('Triggered ajaxSuccess handler. The ajax response was:' 
                     + xhr.responseText );
  }
});

Example:

Show a message when an Ajax request completes successfully.

$("#msg").ajaxSuccess(function(evt, request, settings){
      $(this).append("<li>Successful Request!</li>");
      });

Support and Contributions

Need help with .ajaxSuccess() or have a question about it? Visit the jQuery Forum or the #jquery channel on irc.freenode.net.

Think you've discovered a jQuery bug related to .ajaxSuccess()? Report it to the jQuery core team.

Found a problem with this documentation? Report it on the GitHub issue tracker

  • Anonymous

    What is the main difference between ajaxComplete() and ajaxSuccess()???

    • http://www.learningjquery.com/ Karl Swedberg

      ajaxComplete() is triggered even if the response is an error. It’s like ajaxSuccess() and ajaxError() combined.

  • http://www.madsendev.com Russell Madsen

    I'm assuming that ajaxSuccess, ajaxError are called before ajaxComplete.

    It would make sense since in jQuery.ajax the error and success methods are called first. I just wanted to make sure since I didn't read that in the description.

    • Test

      jjjjjjjjfghfghhhhhhhhhhh

  • http://www.waxworlds.org/edam edam

    Does anyone know what the exact conditions are for the XHR to be considered a success? I imagine the 2xx family of status codes (e.g., 200) would be called a success. What about when no status code can be obtained though (e.g., connection timeouts)? The Prototype JS library treats these as successes (which they say is a “general HTTP guideline”, although it's not one I'm familiar with!) and I wondered if jQuery followed the same logic?

  • Truthblue82

    I did the same, but with jquery 1.3.2 library, it runs ok. Why jquery 1.4.2 not run?

  • resiel

    can you access to the data returned by an ajax request from this event set as global? how?

  • https://www.google.com/accounts/o8/id?id=AItOawk3vLbu8fbTW1XU8f76LIqxqvGYXw1uui8 Arnaud F.

    Why triggering this global callback after the local one and not the opposite?

  • https://www.google.com/accounts/o8/id?id=AItOawk3vLbu8fbTW1XU8f76LIqxqvGYXw1uui8 Arnaud F.

    Why triggering this global callback after the local one and not the opposite?